Explorateur d'API
Explorez la surface de l'API de la plateforme Inklura. Regroupée par router, chaque opération indique sa méthode, son chemin, son corps de requête et sa réponse. Renseignez vos identifiants ci-dessous pour copier un cURL prêt à l'emploi ou exécuter la requête.
Note
Chaque opération est une procédure tRPC appelée sur /api/trpc/<router>.<procedure> : les mutations en POST (corps {"json": <input>}), les requêtes en GET (?input=<json>). Le corps affiché est cette charge json ; les réponses sont encapsulées en superjson. Toutes les requêtes s'authentifient avec un JWT Bearer. Voir le guide tRPC.
Serveur: https://manage.inklura.fr · 307 opérations · Télécharger la spécification OpenAPI complète
Identifiants & contexteStockés uniquement dans votre navigateur (localStorage) — jamais envoyés au site docs.
auth 12
POST/api/trpc/auth.bridgeOidcBridge Oidc
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredsubstringrequiredemailstring · emailrequiredfirstNameanyoptionallastNameanyoptionalnameanyoptionalRéponses
200 Successful response — the `json` result (superjson-wrapped as { result: { data: { json: … } } }).
userIdstringrequiredemailstringrequiredfirstNamestringrequiredlastNamestringrequirednamestringrequiredroleenumrequiredproStatusenumoptionaltenantIdstringrequiredsiteIdstringrequiredEntrée (JSON)
GET/api/trpc/auth.canAccessManageCan Access Manage
Authentification: JWT Bearer requis
Réponses
200 Successful response — the `json` result (superjson-wrapped as { result: { data: { json: … } } }).
allowedbooleanrequiredGET/api/trpc/auth.getProfileGet Profile
Authentification: JWT Bearer requis
Corps de la requête
jsonanyrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/auth.getSecretMessageGet Secret Message
Authentification: JWT Bearer requis
Réponses
200 Successful response — the `json` result (superjson-wrapped as { result: { data: { json: … } } }).
string
GET/api/trpc/auth.getSessionGet Session
Authentification: JWT Bearer requis
Corps de la requête
jsonanyrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/auth.getUserInfoGet User Info
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredemailstringrequiredRéponses
200 Successful response — the `json` result (superjson-wrapped as { result: { data: { json: … } } }).
inputstringrequiredokbooleanrequireduseranyrequiredEntrée (JSON)
POST/api/trpc/auth.loginLogin
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredemailstring · emailrequiredpasswordstringrequiredsitestringoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/auth.registerRegister
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredemailstring · emailrequiredpasswordstringrequiredconfirmPasswordstringrequiredfirstNamestringrequiredlastNamestringrequiredisArchitectbooleanoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/auth.requestPasswordResetRequest Password Reset
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredemailstring · emailrequiredRéponses
200 Successful response — the `json` result (superjson-wrapped as { result: { data: { json: … } } }).
successbooleanrequiredmessagestringrequiredEntrée (JSON)
POST/api/trpc/auth.resendVerificationEmailResend Verification Email
Authentification: JWT Bearer requis
Réponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
POST/api/trpc/auth.signupSignup
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredemailstring · emailrequiredpasswordstringrequiredfirstNamestringrequiredlastNamestringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/auth.verifyEmailVerify Email
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredtokenstringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
campaigns 14
POST/api/trpc/campaigns.createCampaignCreate Campaign
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequirednamestringrequiredtypestringrequiredsubjectstringoptionalcontentstringoptionalscheduledbooleanrequiredscheduledDateanyoptionaltestModebooleanrequiredtestEmailstring · emailoptionaltemplateIdstringoptionalsegmentIdstringoptionalmarketingCampaignIdstringoptionalchannelTypestringoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/campaigns.createCampaignTagCreate Campaign Tag
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequirednamestringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/campaigns.createCampaignWizardCreate Campaign Wizard
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredchannelTypeobjectrequiredchannelTypestringrequiredcampaignobjectoptionalmarketingCampaignIdstringoptionaldetailsobjectrequirednamestringrequiredtypeIdstringoptionalstatusenumrequiredstartDateanyrequiredendDateanyoptionaldescriptionstringoptionaltemplateobjectrequiredtemplateIdstringoptionalsubjectstringrequiredcontentstringrequiredmjmlstringrequiredpreviewTextstringoptionaldataSchemaobjectoptionalaudienceobjectrequiredsegmentsstring[]requiredfiltersobjectoptionalexcludedSegmentsstring[]optionalscheduleobjectrequiredsendTimeenumrequiredscheduledDateanyoptionaltimezonestringrequiredthrottlingobjectoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/campaigns.deleteCampaignDelete Campaign
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/campaigns.duplicateCampaignDuplicate Campaign
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/campaigns.getCampaignActivityGet Campaign Activity
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstringrequiredpagenumberrequiredper_pagenumberrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/campaigns.getCampaignByIdGet Campaign By Id
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/campaigns.getCampaignsGet Campaigns
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredpagenumberrequiredper_pagenumberrequiredsearchstringrequiredstatusstringoptionalRéponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
dataany[]optionaltotalintegeroptionalpageintegeroptionalper_pageintegeroptionaltotalPagesintegeroptionalEntrée (JSON)
GET/api/trpc/campaigns.getCampaignTagsGet Campaign Tags
Authentification: JWT Bearer requis
Réponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
idstringoptionalnamestringoptionaldescriptionanyoptionaltenantIdstringoptionalsiteIdstringoptionalPOST/api/trpc/campaigns.pauseCampaignPause Campaign
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/campaigns.resumeCampaignResume Campaign
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/campaigns.sendCampaignSend Campaign
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/campaigns.simulateActivitySimulate Activity
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/campaigns.updateCampaignUpdate Campaign
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequirednamestringrequiredtypestringrequiredsubjectstringoptionalcontentstringoptionalscheduledbooleanrequiredscheduledDateanyoptionaltestModebooleanrequiredtestEmailstring · emailoptionaltemplateIdstringoptionalsegmentIdstringoptionalmarketingCampaignIdstringoptionalchannelTypestringoptionalidstringrequiredstatusenumoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
clients 18
POST/api/trpc/clients.approveProApprove Pro
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredclientIdstring · uuidrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/clients.createCreate
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequirednamestringrequiredemailstring · emailoptionalphonestringoptionaladdressstringoptionalzipCodestringoptionalcitystringoptionalcountrystringoptionalsiretstringoptionalcodeNafstringoptionaltypeIdstringoptionalarchivedbooleanrequiredisMainRecordbooleanrequiredisProfessionalbooleanrequiredexternalIdstringoptionalmainRecordIdstringoptionaltiersIdanyoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/clients.deleteAllClientsDelete All Clients
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredconfirmationIdstringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/clients.deleteClientDelete Client
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/clients.deleteClientsDelete Clients
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidsstring[]requiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/clients.getClientByIdGet Client By Id
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstringrequiredRéponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
idstringoptionalnamestringoptionaladdressanyoptionalzipCodeanyoptionalcityanyoptionalcountryanyoptionalemailstringoptionalphoneanyoptionalsiretanyoptionalcodeNafanyoptionalcustomInputsobjectoptionallastNamestringoptionalfirstNamestringoptionallastUpdatedstringoptionalprestashop_idstringoptionalexternalIdanyoptionalarchivedbooleanoptionalisProfessionalbooleanoptionaltenantIdstringoptionalsiteIdstringoptionalcreatedAtstringoptionalupdatedAtstringoptionalisMainRecordbooleanoptionalmainRecordIdanyoptionaltypeIdanyoptionaltiersIdanyoptionalterritoryIdanyoptionaldataanyoptionaltypeanyoptionalTiersanyoptionalsentInvoicesany[]optionalreceivedInvoicesany[]optionalreceivedOrdersobject[]optionalidstringoptionalinvoiceNumberstringoptionalinvoiceStatusstringoptionaltotalAmountnumberoptionalcreatedAtstringoptionalinvoiceDatestringoptionaldeliveryDatestringoptionalEntrée (JSON)
GET/api/trpc/clients.getClientContactsGet Client Contacts
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredclientIdstringrequiredpagenumberrequiredper_pagenumberrequiredsearchstringoptionalsortstringoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/clients.getClientsByTiersGet Clients By Tiers
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredtiersIdstringrequiredpagenumberrequiredper_pagenumberrequiredsearchstringoptionalsortstringoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/clients.getClientsGet Clients
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredpagenumberrequiredper_pagenumberrequiredsortstringoptionalsearchanyoptionalcursoranyoptionalfiltersobjectoptionaladvancedFiltersany[]optionaladvancedSortsobject[]optionalfieldstringrequireddirectionenumrequiredRéponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
dataobject[]optionalidstringoptionalnamestringoptionalemailstringoptionalphoneanyoptionaladdressanyoptionalzipCodeanyoptionalcityanyoptionalcountryanyoptionalsiretanyoptionalcodeNafanyoptionalarchivedbooleanoptionalcreatedAtstringoptionalupdatedAtstringoptionalisMainRecordbooleanoptionalisProfessionalbooleanoptionalexternalIdanyoptionalmainRecordIdanyoptionaltypeIdanyoptionaltiersIdanyoptionalcustomInputsobjectoptionaltypeanyoptionalTiersanyoptionalsentInvoicesany[]optionalreceivedInvoicesany[]optionalreceivedOrdersobject[]optionaltotalintegeroptionalpageCountintegeroptionalcolumnsobjectoptionalnameobjectoptionaltypestringoptionallabelstringoptionalrequiredbooleanoptionalsortablebooleanoptionalfilterablebooleanoptionaltypeobjectoptionaltypestringoptionallabelstringoptionalrequiredbooleanoptionalsortablebooleanoptionalfilterablebooleanoptionalrelationTablestringoptionalrelationLabelFieldstringoptionalrelationColorFieldstringoptionalrelationIconFieldstringoptionalemailobjectoptionaltypestringoptionallabelstringoptionalrequiredbooleanoptionalsortablebooleanoptionalfilterablebooleanoptionalphoneobjectoptionaltypestringoptionallabelstringoptionalrequiredbooleanoptionalsortablebooleanoptionalfilterablebooleanoptionaladdressobjectoptionaltypestringoptionallabelstringoptionalrequiredbooleanoptionalsortablebooleanoptionalfilterablebooleanoptionalzipCodeobjectoptionaltypestringoptionallabelstringoptionalrequiredbooleanoptionalsortablebooleanoptionalfilterablebooleanoptionalcityobjectoptionaltypestringoptionallabelstringoptionalrequiredbooleanoptionalsortablebooleanoptionalfilterablebooleanoptionalcountryobjectoptionaltypestringoptionallabelstringoptionalrequiredbooleanoptionalsortablebooleanoptionalfilterablebooleanoptionalsiretobjectoptionaltypestringoptionallabelstringoptionalrequiredbooleanoptionalsortablebooleanoptionalfilterablebooleanoptionalcodeNafobjectoptionaltypestringoptionallabelstringoptionalrequiredbooleanoptionalsortablebooleanoptionalfilterablebooleanoptionalarchivedobjectoptionaltypestringoptionallabelstringoptionalrequiredbooleanoptionalsortablebooleanoptionalfilterablebooleanoptionaloptionsobject[]optionalisProfessionalobjectoptionaltypestringoptionallabelstringoptionalrequiredbooleanoptionalsortablebooleanoptionalfilterablebooleanoptionaloptionsobject[]optionalisMainRecordobjectoptionaltypestringoptionallabelstringoptionalrequiredbooleanoptionalsortablebooleanoptionalfilterablebooleanoptionaloptionsobject[]optionalcreatedAtobjectoptionaltypestringoptionallabelstringoptionalrequiredbooleanoptionalsortablebooleanoptionalfilterablebooleanoptionalupdatedAtobjectoptionaltypestringoptionallabelstringoptionalrequiredbooleanoptionalsortablebooleanoptionalfilterablebooleanoptionalnextCursorintegeroptionalEntrée (JSON)
POST/api/trpc/clients.linkContactLink Contact
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredclientIdstringrequiredcontactIdstringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/clients.listPendingProList Pending Pro
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredpagenumberrequiredperPagenumberrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/clients.refuseProRefuse Pro
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredclientIdstring · uuidrequiredreasonstringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/clients.requestProSignupRequest Pro Signup
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredcompanyNamestringrequiredsiretstringrequiredcodeNafanyoptionaladdressstringrequiredzipCodestringrequiredcitystringrequiredfirstNamestringrequiredlastNamestringrequiredroleanyoptionalphonestringrequiredemailstring · emailrequiredpasswordstringrequiredfilierestringrequiredvolumeEstimateanyoptionalmessageanyoptionalnewsletterbooleanrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/clients.searchContactsToLinkSearch Contacts To Link
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredsearchstringoptionalpagenumberrequiredper_pagenumberrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/clients.syncClientsSync Clients
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredoffsetnumberrequiredlimitnumberrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/clients.unlinkContactUnlink Contact
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredclientIdstringrequiredcontactIdstringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/clients.unlinkTiersUnlink Tiers
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/clients.updateClientUpdate Client
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstringrequirednamestringoptionalemailstring · emailoptionalphonestringoptionaladdressstringoptionalzipCodestringoptionalcitystringoptionalcountrystringoptionalsiretstringoptionalcodeNafstringoptionaltypeIdstringoptionalarchivedbooleanoptionalisMainRecordbooleanoptionalisProfessionalbooleanoptionalexternalIdstringoptionalmainRecordIdstringoptionaltiersIdanyoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
coupons 6
POST/api/trpc/coupons.createCreate
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredcodestringrequiredtypeenumrequiredvalueintegerrequiredappliesToPlanIdsstring[]requiredappliesToCountryanyoptionalappliesToDurationYearsanyoptionalvalidFromanyoptionalvalidToanyoptionalmaxRedemptionsanyoptionaldescriptionanyoptionalactivebooleanrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/coupons.deleteDelete
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstring · uuidrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/coupons.getGet
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstring · uuidrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/coupons.listList
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredactiveOnlybooleanrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/coupons.updateUpdate
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredcodestringoptionaltypeenumoptionalvalueintegeroptionalappliesToPlanIdsstring[]optionalappliesToCountryanyoptionalappliesToDurationYearsanyoptionalvalidFromanyoptionalvalidToanyoptionalmaxRedemptionsanyoptionaldescriptionanyoptionalactivebooleanoptionalidstring · uuidrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/coupons.validateValidate
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredcodestringrequiredcountryenumrequireditemsobject[]requiredplanIdstringrequiredkindenumrequireddurationYearsintegeroptionallineTotalnumberrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
helpdeskKb 10
POST/api/trpc/helpdeskKb.createArticleCreate Article
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredtitlestringrequiredslugstringoptionalexcerptstringoptionalbodystringoptionalstatusstringoptionalvisibilitystringoptionalcategoryIdanyoptionaltagsstring[]optionalseoTitlestringoptionalseoDescriptionstringoptionalordernumberoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/helpdeskKb.createCategoryCreate Category
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequirednamestringrequiredslugstringoptionaldescriptionstringoptionaliconstringoptionalparentIdanyoptionalordernumberoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/helpdeskKb.deleteArticleDelete Article
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/helpdeskKb.deleteCategoryDelete Category
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/helpdeskKb.getArticleByIdGet Article By Id
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/helpdeskKb.getArticlesGet Articles
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredsearchstringoptionalstatusstringoptionalvisibilitystringoptionalcategoryIdstringoptionalincludeArchivedbooleanrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/helpdeskKb.getCategoriesGet Categories
Authentification: JWT Bearer requis
Réponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
GET/api/trpc/helpdeskKb.getCategoryByIdGet Category By Id
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/helpdeskKb.updateArticleUpdate Article
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredtitlestringoptionalslugstringoptionalexcerptstringoptionalbodystringoptionalstatusstringoptionalvisibilitystringoptionalcategoryIdanyoptionaltagsstring[]optionalseoTitlestringoptionalseoDescriptionstringoptionalordernumberoptionalidstringrequiredarchivedbooleanoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/helpdeskKb.updateCategoryUpdate Category
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequirednamestringoptionalslugstringoptionaldescriptionstringoptionaliconstringoptionalparentIdanyoptionalordernumberoptionalidstringrequiredarchivedbooleanoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
invoices 26
POST/api/trpc/invoices.convertQuoteConvert Quote
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/invoices.createCreditNoteCreate Credit Note
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/invoices.createDraftCreate Draft
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredreceiverIdstringrequiredinvoiceTypeenumoptionalinvoiceDatestringoptionaldueDatestringoptionalnotesstringoptionalcurrencystringoptionaltemplateIdintegeroptionalitemsobject[]requirednamestringrequiredquantitynumberrequiredunitPricenumberrequiredtaxRatenumberrequiredproductIdstringoptionalproductSkustringoptionaldiscountobjectoptionaltypeenumrequiredvaluenumberrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/invoices.createInvoiceCreate Invoice
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequirednumberstringrequiredclientIdstringrequiredtotalnumberrequireditemsobject[]requireddescriptionstringrequiredquantitynumberrequiredunitPricenumberrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/invoices.createStripeConnectAccountCreate Stripe Connect Account
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredrefreshUrlstring · urirequiredreturnUrlstring · urirequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/invoices.createStripeConnectLinkCreate Stripe Connect Link
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredrefreshUrlstring · urirequiredreturnUrlstring · urirequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/invoices.deleteAllInvoicesDelete All Invoices
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredconfirmationIdstringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/invoices.deleteInvoiceDelete Invoice
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/invoices.deleteIssuerProfileDelete Issuer Profile
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredscopeobjectrequiredlevelenumrequireddomainIdstringoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/invoices.disconnectStripeDisconnect Stripe
Authentification: JWT Bearer requis
Réponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
GET/api/trpc/invoices.getClientsForSelectGet Clients For Select
Authentification: JWT Bearer requis
Réponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
idstringoptionalnamestringoptionalemailstringoptionalGET/api/trpc/invoices.getCrossTenantOverviewGet Cross Tenant Overview
Authentification: JWT Bearer requis
Réponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
GET/api/trpc/invoices.getCrossTenantPaymentStatusGet Cross Tenant Payment Status
Authentification: JWT Bearer requis
Réponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
GET/api/trpc/invoices.getDashboardMetricsGet Dashboard Metrics
Authentification: JWT Bearer requis
Réponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
monthlyobject[]optionallabelstringoptionalfactureintegeroptionalencaisseintegeroptionalbyStatusany[]optionalGET/api/trpc/invoices.getEffectiveIssuerProfileGet Effective Issuer Profile
Authentification: JWT Bearer requis
Réponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
GET/api/trpc/invoices.getInvoiceGet Invoice
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstringrequiredRéponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
idstringoptionalsenderIdstringoptionalreceiverIdstringoptionalinvoiceLogoanyoptionalinvoiceNumberstringoptionalinvoiceDatestringoptionalinvoiceTypeanyoptionalinvoiceStatusstringoptionaldueDateanyoptionalpurchaseOrderNumberanyoptionalcurrencystringoptionallanguagestringoptionalpaymentInformationobjectoptionaltaxDetailsobjectoptionaldiscountDetailsobjectoptionalshippingDetailsobjectoptionalsubTotalanyoptionaltotalAmountintegeroptionaltotalAmountInWordsstringoptionaladditionalNotesanyoptionalpaymentTermsstringoptionalpaymentMethodanyoptionalsignatureobjectoptionalstartedAtanyoptionalendedAtanyoptionallocationanyoptionalcreatedAtstringoptionalupdatedAtstringoptionalpdfTemplateintegeroptionalpdfFormatanyoptionalcustomInputsanyoptionalfooteranyoptionalsourceanyoptionalemplacementIdanyoptionaltenantIdstringoptionaluserIdanyoptionalsiteIdstringoptionalrecurringInvoiceIdanyoptionaldomainIdanyoptionalissuerProfileIdanyoptionalsequenceKeyanyoptionalissuedAtanyoptionallockedbooleanoptionalitemsany[]optionalreceiverobjectoptionalidstringoptionalnamestringoptionaladdressanyoptionalzipCodeanyoptionalcityanyoptionalcountryanyoptionalemailanyoptionalphoneanyoptionalsiretanyoptionalcodeNafanyoptionalcustomInputsobjectoptionalexternalIdanyoptionalarchivedbooleanoptionalisProfessionalbooleanoptionaltenantIdstringoptionalsiteIdstringoptionalcreatedAtstringoptionalupdatedAtstringoptionalisMainRecordbooleanoptionalmainRecordIdanyoptionaltypeIdanyoptionaltiersIdanyoptionalterritoryIdanyoptionaldataanyoptionalsenderobjectoptionalidstringoptionalnamestringoptionaladdressanyoptionalzipCodeanyoptionalcityanyoptionalcountryanyoptionalemailanyoptionalphoneanyoptionalsiretanyoptionalcodeNafanyoptionalcustomInputsobjectoptionalexternalIdanyoptionalarchivedbooleanoptionalisProfessionalbooleanoptionaltenantIdstringoptionalsiteIdstringoptionalcreatedAtstringoptionalupdatedAtstringoptionalisMainRecordbooleanoptionalmainRecordIdanyoptionaltypeIdanyoptionaltiersIdanyoptionalterritoryIdanyoptionaldataanyoptionalpdfUrlanyoptionalEntrée (JSON)
GET/api/trpc/invoices.getInvoicesGet Invoices
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredlimitnumberrequiredoffsetnumberrequiredstatusstringoptionaltypeenumoptionalRéponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
idstringoptionalsenderIdstringoptionalreceiverIdstringoptionalinvoiceLogoanyoptionalinvoiceNumberstringoptionalinvoiceDatestringoptionalinvoiceTypeanyoptionalinvoiceStatusstringoptionaldueDateanyoptionalpurchaseOrderNumberanyoptionalcurrencystringoptionallanguagestringoptionalpaymentInformationobjectoptionaltaxDetailsobjectoptionaldiscountDetailsobjectoptionalshippingDetailsobjectoptionalsubTotalanyoptionaltotalAmountintegeroptionaltotalAmountInWordsstringoptionaladditionalNotesanyoptionalpaymentTermsstringoptionalpaymentMethodanyoptionalsignatureobjectoptionalstartedAtanyoptionalendedAtanyoptionallocationanyoptionalcreatedAtstringoptionalupdatedAtstringoptionalpdfTemplateintegeroptionalpdfFormatanyoptionalcustomInputsanyoptionalfooteranyoptionalsourceanyoptionalemplacementIdanyoptionaltenantIdstringoptionaluserIdanyoptionalsiteIdstringoptionalrecurringInvoiceIdanyoptionaldomainIdanyoptionalissuerProfileIdanyoptionalsequenceKeyanyoptionalissuedAtanyoptionallockedbooleanoptionalreceiverobjectoptionalidstringoptionalnamestringoptionaladdressanyoptionalzipCodeanyoptionalcityanyoptionalcountryanyoptionalemailanyoptionalphoneanyoptionalsiretanyoptionalcodeNafanyoptionalcustomInputsobjectoptionalexternalIdanyoptionalarchivedbooleanoptionalisProfessionalbooleanoptionaltenantIdstringoptionalsiteIdstringoptionalcreatedAtstringoptionalupdatedAtstringoptionalisMainRecordbooleanoptionalmainRecordIdanyoptionaltypeIdanyoptionaltiersIdanyoptionalterritoryIdanyoptionaldataanyoptionalpdfUrlanyoptionalEntrée (JSON)
GET/api/trpc/invoices.getIssuerProfileGet Issuer Profile
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredscopeobjectoptionallevelenumrequireddomainIdstringoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/invoices.getPaymentSettingsGet Payment Settings
Authentification: JWT Bearer requis
Réponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
GET/api/trpc/invoices.getPublicInvoiceGet Public Invoice
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredtokenstringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/invoices.listIssuerScopesList Issuer Scopes
Authentification: JWT Bearer requis
Réponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
POST/api/trpc/invoices.saveIssuerProfileSave Issuer Profile
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredscopeobjectoptionallevelenumrequireddomainIdstringoptionallegalNamestringrequiredemailstringoptionalphonestringoptionalsiretstringoptionalsirenstringoptionalvatNumberstringoptionalibanstringoptionalbicstringoptionallogoUrlstringoptionalcurrencystringoptionaleditorLayoutenumoptionalpdfTemplateintegeroptionalinvoicePrefixstringoptionalquotePrefixstringoptionalcreditNotePrefixstringoptionallegalMentionsstringoptionaladdressobjectoptionalstreetstringoptionalcitystringoptionalpostalCodestringoptionalcountrystringoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/invoices.savePaymentKeysSave Payment Keys
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredsecretKeystringoptionalpublishableKeystringoptionalenabledbooleanoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/invoices.searchProductsSearch Products
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredqstringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/invoices.updateDraftUpdate Draft
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstringrequiredreceiverIdstringoptionalinvoiceTypeenumoptionalinvoiceDatestringoptionaldueDatestringoptionalnotesstringoptionalcurrencystringoptionaltemplateIdintegeroptionalitemsobject[]requirednamestringrequiredquantitynumberrequiredunitPricenumberrequiredtaxRatenumberrequiredproductIdstringoptionalproductSkustringoptionaldiscountobjectoptionaltypeenumrequiredvaluenumberrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/invoices.updateInvoiceStatusUpdate Invoice Status
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstringrequiredstatusstringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
newsletter 18
POST/api/trpc/newsletter.addSubscriberAdd Subscriber
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredemailstringrequiredfirstNamestringoptionallastNamestringoptionaltagsstring[]optionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/newsletter.bulkDeleteBulk Delete
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidsstring[]requiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/newsletter.bulkUpdateStatusBulk Update Status
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidsstring[]requiredstatusenumrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/newsletter.exportSubscribersExport Subscribers
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredformatenumrequiredsubscribedOnlybooleanrequiredRéponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
datastringoptionalformatstringoptionalEntrée (JSON)
GET/api/trpc/newsletter.getAvailableTemplatesGet Available Templates
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredtypeenumrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/newsletter.getGrowthDataGet Growth Data
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequireddaysnumberrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/newsletter.getSettingsGet Settings
Authentification: JWT Bearer requis
Réponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
doubleOptInbooleanoptionalconfirmationEmailTemplateIdanyoptionalconfirmationTokenExpiryintegeroptionalwelcomeEmailEnabledbooleanoptionalwelcomeEmailTemplateIdanyoptionalwelcomeEmailDelayintegeroptionalunsubscribeConfirmationEnabledbooleanoptionalunsubscribeConfirmationTemplateIdanyoptionaladminNotificationEnabledbooleanoptionaladminNotificationEmailstringoptionaladminDigestEnabledbooleanoptionaladminDigestFrequencystringoptionaldefaultFromNamestringoptionaldefaultFromEmailstringoptionaldefaultReplyTostringoptionalautoArchiveEnabledbooleanoptionalarchiveVisibilitystringoptionalbrandColorstringoptionalheaderLogoUrlstringoptionalfooterTextstringoptionalGET/api/trpc/newsletter.getStatsGet Stats
Authentification: JWT Bearer requis
Réponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
totalintegeroptionalsubscribedintegeroptionalunsubscribedintegeroptionalthisMonthintegeroptionallastMonthintegeroptionalgrowthPercentintegeroptionalGET/api/trpc/newsletter.getSubscriberGet Subscriber
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstringrequiredRéponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
idstringoptionalfirstNameanyoptionallastNameanyoptionalnamestringoptionalemailstringoptionalphoneanyoptionalmarketingOptInbooleanoptionalemailOptInbooleanoptionalsmsOptInbooleanoptionalsegmentanyoptionalsourceanyoptionalcreatedAtstringoptionallastActivityanyoptionalEntrée (JSON)
GET/api/trpc/newsletter.getSubscriptionStatusGet Subscription Status
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredemailstringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/newsletter.importSubscribersImport Subscribers
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredsubscribersobject[]requiredemailstring · emailrequiredfirstNamestringoptionallastNamestringoptionalphonestringoptionalduplicateHandlingenumrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/newsletter.listSubscribersList Subscribers
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredpagenumberrequiredlimitnumberrequiredsearchstringoptionalsubscribedbooleanoptionalsortByenumrequiredsortOrderenumrequiredRéponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
itemsobject[]optionalidstringoptionalfirstNameanyoptionallastNameanyoptionalnamestringoptionalemailstringoptionalmarketingOptInbooleanoptionalemailOptInbooleanoptionalsmsOptInbooleanoptionalsegmentanyoptionalsourceanyoptionalsubscribedAtstringoptionallastActivityanyoptionaltotalintegeroptionalpageintegeroptionallimitintegeroptionalpagesintegeroptionalEntrée (JSON)
POST/api/trpc/newsletter.subscribeSubscribe
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredemailstringrequiredfirstNamestringoptionallastNamestringoptionaltenantIdstringoptionalsiteIdstringoptionalhoneypotstringoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/newsletter.testConfirmationEmailTest Confirmation Email
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredemailstring · emailrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/newsletter.testWelcomeEmailTest Welcome Email
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredemailstring · emailrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/newsletter.unsubscribeUnsubscribe
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredemailstringrequiredtokenstringoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/newsletter.updateSettingsUpdate Settings
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequireddoubleOptInbooleanoptionalconfirmationEmailTemplateIdanyoptionalconfirmationTokenExpirynumberoptionalwelcomeEmailEnabledbooleanoptionalwelcomeEmailTemplateIdanyoptionalwelcomeEmailDelaynumberoptionalunsubscribeConfirmationEnabledbooleanoptionalunsubscribeConfirmationTemplateIdanyoptionaladminNotificationEnabledbooleanoptionaladminNotificationEmailanyoptionaladminDigestEnabledbooleanoptionaladminDigestFrequencyenumoptionaldefaultFromNamestringoptionaldefaultFromEmailanyoptionaldefaultReplyToanyoptionalautoArchiveEnabledbooleanoptionalarchiveVisibilityenumoptionalbrandColorstringoptionalheaderLogoUrlanyoptionalfooterTextstringoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/newsletter.updateSubscriberUpdate Subscriber
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstring · uuidrequiredmarketingOptInbooleanoptionalemailOptInbooleanoptionalsmsOptInbooleanoptionalfirstNamestringoptionallastNamestringoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
orders 48
POST/api/trpc/orders.createOrderItemCreate Order Item
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredorderIdstring · uuidrequirednamestringrequireddescriptionanyoptionalquantityintegerrequiredunitPricenumberrequiredproductIdanyoptionalvendorIdanyoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/orders.createOrderCreate Order
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredinvoiceNumberanyrequiredinvoiceDateanyrequireddeliveryDateanyoptionalinvoiceStatusenumrequiredreceiverIdstringoptionalsenderIdstringoptionalclientIdstringoptionalcurrencystringrequiredtotalAmountnumberrequiredadditionalNotesstringoptionalitemsobject[]requiredproductIdstringoptionalnamestringrequireddescriptionanyoptionalquantityintegerrequiredunitPricenumberrequiredrecalculateVendorsbooleanoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/orders.deleteOrderItemDelete Order Item
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstring · uuidrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/orders.deleteOrderDelete Order
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/orders.deleteOrdersDelete Orders
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidsstring[]requiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/orders.exportOrdersExport Orders
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredformatenumrequiredfiltersobjectoptionalsearchstringoptionalsortstringoptionaladvancedFiltersany[]optionaladvancedSortsobject[]optionalcolumnsstring[]optionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/orders.fetchOrdersFetch Orders
Authentification: JWT Bearer requis
Réponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
POST/api/trpc/orders.fulfillment.cancelFulfillment.cancel
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredfulfillmentIdstring · uuidrequiredreasonstringoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/orders.fulfillment.createFulfillment.create
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredorderIdstring · uuidrequiredmethodenumrequireditemsobject[]requiredorderItemIdstring · uuidrequiredquantityintegerrequiredcarrierstringoptionaltrackingNumberstringoptionaltrackingUrlstring · urioptionalestimatedDeliveryanyoptionalshippingAddressobjectoptionalfirstNamestringrequiredlastNamestringrequiredcompanystringoptionaladdressstringrequiredcitystringrequiredpostalCodestringrequiredcountrystringrequiredphonestringoptionalemailstring · emailoptionalinstructionsstringoptionalshipmentIdstring · uuidoptionalnotesstringoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/orders.fulfillment.listByOrderFulfillment.list By Order
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredorderIdstring · uuidrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/orders.fulfillment.trackFulfillment.track
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredfulfillmentIdstring · uuidrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/orders.fulfillment.updateStatusFulfillment.update Status
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredfulfillmentIdstring · uuidrequiredstatusenumrequiredtrackingNumberstringoptionaltrackingUrlstring · urioptionalactualDeliveryanyoptionalnotesstringoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/orders.getCheckoutEventsGet Checkout Events
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredorderIdstring · uuidrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/orders.getInvoicesGet Invoices
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredpageanyrequiredper_pageanyrequiredsearchstringoptionalsortstringoptionalfiltersobjectoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/orders.getLiveOrdersGet Live Orders
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredstatusesstring[]optionallimitnumberrequiredsortByenumrequiredsortOrderenumrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/orders.getMyOrdersGet My Orders
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredlimitnumberrequiredcursorstringoptionalstatusstringoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/orders.getOrderByIdGet Order By Id
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstringrequiredRéponses
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[]optionalEntrée (JSON)
GET/api/trpc/orders.getOrderItemsGet Order Items
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredorderIdstringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/orders.getOrdersByIdsForProductsGet Orders By Ids For Products
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidsstring[]requiredproductIdsstring[]optionalincludeItemsbooleanoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/orders.getOrdersByIdsGet Orders By Ids
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidsstring[]requiredproductIdstring · uuidoptionalincludeItemsbooleanoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/orders.getOrdersByProductGet Orders By Product
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredproductIdstring · uuidrequiredpageanyrequiredper_pageanyrequiredsearchanyoptionalstatusanyoptionalsortanyoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/orders.getOrdersByVendorGet Orders By Vendor
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredvendorIdstring · uuidrequiredpagenumberrequiredper_pagenumberrequiredsearchstringoptionalstatusenumoptionalstatusesstring[]optionaldeliveryDateFromstringoptionaldeliveryDateTostringoptionalsortstringoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/orders.getOrdersGet Orders
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredpageanyrequiredper_pageanyrequiredsearchanyoptionalsortanyoptionalfiltersobjectrequiredadvancedFiltersany[]requiredadvancedSortsobject[]requiredfieldstringrequireddirectionenumrequiredfieldsanyoptionalpaymentLinkFilterenumoptionalofflinePaymentFilterenumoptionalRéponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
dataobject[]optionalidstringoptionalinvoiceNumberstringoptionalinvoiceDatestringoptionalinvoiceStatusstringoptionaltotalAmountnumberoptionalcurrencystringoptionalcreatedAtstringoptionalupdatedAtstringoptionalpaymentMethodanyoptionalexpiresAtanyoptionaldeliveryDatestringoptionalcustomInputsobjectoptionalsourceanyoptionalreceiverobjectoptionalsenderobjectoptionalclientobjectoptionalvendorsany[]optionalitemsobject[]optionaltotalintegeroptionalpageintegeroptionalpageSizeintegeroptionalpageCountintegeroptionalhasNextPagebooleanoptionalhasPrevPagebooleanoptionalEntrée (JSON)
GET/api/trpc/orders.getOrderSubscriptionContextGet Order Subscription Context
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredorderIdstringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/orders.getOrderTimersGet Order Timers
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredorderIdsstring[]optionalactiveOnlybooleanrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/orders.getProductsByOrderGet Products By Order
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredorderIdstring · uuidrequiredpageanyrequiredper_pageanyrequiredsearchanyoptionalsortanyoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/orders.getRelatedSupplierOrdersGet Related Supplier Orders
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredorderIdstring · uuidrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/orders.getUnfulfilledOrdersGet Unfulfilled Orders
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredsearchstringoptionallimitnumberoptionalRéponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
ordersobject[]optionalidstringoptionalnumberstringoptionalstatusstringoptionalcustomerNamestringoptionalcustomerobjectoptionalcreatedAtstringoptionalitemsobject[]optionaltotalintegeroptionalEntrée (JSON)
POST/api/trpc/orders.lifecycle.cancelOrderLifecycle.cancel Order
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredorderIdstring · uuidrequiredreleaseStockbooleanrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/orders.lifecycle.confirmOrderPaymentLifecycle.confirm Order Payment
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredorderIdstring · uuidrequiredpaymentIntentIdstringoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/orders.lifecycle.expireDraftOrdersLifecycle.expire Draft Orders
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredtenantIdstring · uuidoptionalsiteIdstring · uuidoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/orders.lifecycle.getDashboardDataLifecycle.get Dashboard Data
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredtimeRangeenumrequiredalertsLimitintegerrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/orders.lifecycle.getLifecycleAlertsLifecycle.get Lifecycle Alerts
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredlimitintegerrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/orders.lifecycle.getLifecycleStatsLifecycle.get Lifecycle Stats
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredtimeRangeenumrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/orders.lifecycle.getOrdersExpiringSoonLifecycle.get Orders Expiring Soon
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredminutesUntilExpiryintegerrequiredtenantIdstring · uuidoptionalsiteIdstring · uuidoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/orders.markPaidMark Paid
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredorderIdstring · uuidrequiredpaymentIntentIdstringrequiredpaymentMethodstringoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/orders.markProcessedMark Processed
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredorderIdstring · uuidrequiredprocessedbooleanrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/orders.refund.calculateRefund.calculate
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredorderIdstring · uuidrequireditemsobject[]optionalorderItemIdstring · uuidrequiredquantityintegerrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/orders.refund.createRefund.create
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredorderIdstring · uuidrequireditemsobject[]optionalorderItemIdstring · uuidrequiredquantityintegerrequiredamountnumberoptionalreasonenumrequiredreasonDescriptionstringoptionalnotesstringoptionalautoApprovebooleanrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/orders.refund.executeRefund.execute
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredrefundIdstring · uuidrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/orders.refund.listByOrderRefund.list By Order
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredorderIdstring · uuidrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/orders.refund.processRefund.process
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredrefundIdstring · uuidrequiredapprovebooleanrequirednotesstringoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/orders.syncOrderSync Order
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredorderIdstring · uuidrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/orders.updateKitchenStatusUpdate Kitchen Status
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstringrequiredkitchenStatusenumrequirednotesstringoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/orders.updateOrderItemUpdate Order Item
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/orders.updateOrderUpdate Order
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstringrequiredinvoiceNumberanyrequiredinvoiceDateanyoptionaldeliveryDateanyoptionalinvoiceStatusenumoptionalreceiverIdanyoptionalsenderIdanyoptionalclientIdanyoptionalvendorIdsstring[]optionalcurrencystringoptionaltotalAmountnumberoptionaladditionalNotesstringoptionalitemsobject[]optionalidstringoptionalproductIdstringoptionalnamestringrequireddescriptionanyoptionalquantityintegerrequiredunitPricenumberrequiredrecalculateVendorsbooleanoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/orders.updateStatusUpdate Status
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstringrequiredstatusenumrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/orders.validateOrderValidate Order
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredorderIdstring · uuidrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
payments 24
POST/api/trpc/payments.applyMyUpdatedCardApply My Updated Card
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredprintSubscriptionIdstring · uuidrequiredpaymentMethodIdstringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/payments.checkStripeConfigurationCheck Stripe Configuration
Authentification: JWT Bearer requis
Réponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
isConfiguredbooleanoptionalPOST/api/trpc/payments.createEditionCheckoutSessionCreate Edition Checkout Session
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequirededitionIdstring · uuidrequiredorderIdstring · uuidoptionalsuccessUrlstringoptionalcancelUrlstringoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/payments.createMagazineCheckoutSessionCreate Magazine Checkout Session
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredsubscriptionPlanIdstring · uuidrequiredsuccessUrlstringoptionalcancelUrlstringoptionalpreviousSubIdstring · uuidoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/payments.createMagazinePurchaseCheckoutSessionCreate Magazine Purchase Checkout Session
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequireditemsobject[]requiredidstring · uuidrequiredtitlestringrequiredpricenumberoptionalquantityintegerrequiredformatenumoptionalkindenumoptionaldurationYearsanyoptionalisMonthlybooleanoptionalisGiftbooleanoptionalgiftRecipientobjectoptionalcountryenumrequiredcustomerInfoobjectoptionalcivilitystringoptionalfirstNamestringrequiredlastNamestringrequiredemailstring · emailrequiredphonestringrequiredcompanystringoptionaladdressstringrequiredaddress2stringoptionalcitystringrequiredpostalCodestringrequiredcountrystringrequirednotesstringoptionalbillingInfoobjectoptionaladdressstringrequiredaddress2stringoptionalcitystringrequiredpostalCodestringrequiredcountrystringrequireddeliveryOptionstringoptionalpaymentMethodstringoptionaltotalsobjectoptionalsubtotalnumberrequireddeliverynumberrequiredtotalnumberrequiredsuccessUrlstringoptionalcancelUrlstringoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/payments.createMyUpdateCardSetupIntentCreate My Update Card Setup Intent
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredprintSubscriptionIdstring · uuidrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/payments.createOfflineMagazineCheckoutCreate Offline Magazine Checkout
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequireditemsobject[]requiredidstringrequiredtitlestringoptionalpricenumberoptionalquantityintegerrequiredformatenumoptionalkindenumoptionaldurationYearsanyoptionalisMonthlybooleanoptionalisGiftbooleanoptionalcountryenumrequiredpaymentMethodenumrequiredcustomerInfoobjectrequiredcivilitystringoptionalfirstNamestringrequiredlastNamestringrequiredemailstring · emailrequiredphonestringrequiredcompanystringoptionaladdressstringrequiredaddress2stringoptionalcitystringrequiredpostalCodestringrequiredcountrystringrequirednotesstringoptionalbillingInfoobjectoptionaladdressstringrequiredaddress2stringoptionalcitystringrequiredpostalCodestringrequiredcountrystringrequiredtotalsobjectoptionalsubtotalnumberoptionaldeliverynumberoptionaltotalnumberrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/payments.createOfflineMagazineSubscriptionCheckoutCreate Offline Magazine Subscription Checkout
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredmagazineSubscriptionPlanIdstring · uuidrequiredisMonthlybooleanrequiredcountryenumrequiredpaymentMethodenumrequiredcustomerInfoobjectrequiredcivilitystringoptionalfirstNamestringrequiredlastNamestringrequiredemailstring · emailrequiredphonestringrequiredcompanystringoptionaladdressstringrequiredaddress2stringoptionalcitystringrequiredpostalCodestringrequiredcountrystringrequirednotesstringoptionalbillingInfoobjectoptionaladdressstringrequiredaddress2stringoptionalcitystringrequiredpostalCodestringrequiredcountrystringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/payments.createOperatorCardSubscriptionCreate Operator Card Subscription
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredtargetContactIdstring · uuidrequiredmagazineSubscriptionPlanIdstring · uuidrequiredcountryenumrequiredmodeenumrequiredstripeCustomerIdstringrequiredpaymentMethodIdstringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/payments.createOperatorSetupIntentCreate Operator Setup Intent
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredtargetContactIdstring · uuidrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/payments.createPaymentIntentCreate Payment Intent
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredorderIdstring · uuidrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/payments.createPerIssueCardSetupCheckoutCreate Per Issue Card Setup Checkout
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredmagazineSubscriptionPlanIdstring · uuidrequiredcountryenumrequiredcustomerEmailstring · emailrequiredcustomerFirstNamestringrequiredcustomerLastNamestringrequiredsuccessUrlstring · urirequiredcancelUrlstring · urirequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/payments.createRecurringMagazineSubscriptionCheckoutCreate Recurring Magazine Subscription Checkout
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredmagazineSubscriptionPlanIdstring · uuidrequiredcountryenumrequiredintervalstringrequiredintervalCountanyrequiredsuccessUrlstring · urirequiredcancelUrlstring · urirequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/payments.createRecurringMagazineSubscriptionLinkForCustomerCreate Recurring Magazine Subscription Link For Customer
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredmagazineSubscriptionPlanIdstring · uuidrequiredtargetContactIdstring · uuidrequiredcountryenumrequiredintervalstringrequiredintervalCountanyrequiredsuccessUrlstring · urirequiredcancelUrlstring · urirequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/payments.createVisitCheckoutSessionCreate Visit Checkout Session
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredreservationIdstring · uuidrequiredsuccessUrlstringoptionalcancelUrlstringoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/payments.getCheckoutFunnelGet Checkout Funnel
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredfromstringoptionaltostringoptionalRéponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
windowobjectoptionalfromstringoptionaltostringoptionalfunnelobjectoptionalreachedCheckoutintegeroptionalpayClickedintegeroptionalsessionCreatedintegeroptionalcompletedintegeroptionalprocessingintegeroptionalmintedEventsintegeroptionalexpiredintegeroptionalabandonedFrontendintegeroptionalerrorsintegeroptionalrevenueobjectoptionalpaidCountintegeroptionalpaidAmountintegeroptionalcurrencystringoptionalpendingobjectoptionalinflightintegeroptionalabandonedintegeroptionaleventsByKindany[]optionalEntrée (JSON)
GET/api/trpc/payments.getMagazineCartPricingGet Magazine Cart Pricing
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequireditemsobject[]requiredidstring · uuidrequiredformatenumoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/payments.getPaymentMethodsGet Payment Methods
Authentification: JWT Bearer requis
Réponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
idstringoptionalnamestringoptionaltypestringoptionalisActivebooleanoptionalGET/api/trpc/payments.getPaymentStatsGet Payment Stats
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequireddateFromanyoptionaldateToanyoptionalRéponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
totalTransactionsintegeroptionaltotalAmountnumberoptionalcompletedTransactionsintegeroptionalfailedTransactionsintegeroptionalpendingTransactionsintegeroptionalprocessingTransactionsintegeroptionalcancelledTransactionsintegeroptionaltotalProcessingFeesnumberoptionalaverageTransactionAmountnumberoptionalEntrée (JSON)
GET/api/trpc/payments.getStripeConfigurationGet Stripe Configuration
Authentification: JWT Bearer requis
Réponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
secretKeyanyoptionalpublishableKeyanyoptionalisConfiguredbooleanoptionalGET/api/trpc/payments.getTransactionByIdGet Transaction By Id
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/payments.getTransactionsGet Transactions
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredpageintegerrequiredper_pageintegerrequireddateFromanyoptionaldateToanyoptionalstatusenumoptionalpaymentMethodstringoptionalorderIdstring · uuidoptionalcustomerIdstring · uuidoptionalRéponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
transactionsany[]optionaltotalintegeroptionalpageintegeroptionalper_pageintegeroptionaltotalPagesintegeroptionalEntrée (JSON)
GET/api/trpc/payments.listAbandonedCheckoutsList Abandoned Checkouts
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredstateenumrequiredlimitnumberrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/payments.updateStripeConfigurationUpdate Stripe Configuration
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredsecretKeystringrequiredpublishableKeystringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
products 27
POST/api/trpc/products.assignSubCategoryToProductAssign Sub Category To Product
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredproductIdstring · uuidrequiredsubCategoryIdstring · uuidrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/products.bulkUpdateBulk Update
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredupdatesobject[]requiredidstring · uuidrequirednamestringoptionaldescriptionstringoptionalreferencestringoptionalmanufacturerstringoptionalactivebooleanoptionalpricenumberoptionalproPriceanyoptionaltaxRatenumberoptionalisBuyablebooleanoptionalpackagingQuantitynumberoptionalpackagingUnitstringoptionalsaleDetailstringoptionalsaleQuantitynumberoptionalsaleUnitstringoptionalsaleTypestringoptionalstockintegeroptionaldefaultVendorIdstringoptionalpackagingTypeIdstringoptionaldataPatchobjectoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/products.byPackagingTypeBy Packaging Type
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredpackagingTypeIdstringrequiredpagenumberrequiredlimitnumberrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/products.clearProductsCacheClear Products Cache
Authentification: JWT Bearer requis
Réponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
POST/api/trpc/products.createCreate
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequirednamestringrequireddescriptionstringoptionalpricenumberrequiredproPriceanyoptionalreferencestringoptionalmanufacturerstringoptionaltaxRatenumberrequireddefaultVendorIdstringoptionalpackagingTypeIdstringoptionalpackagingQuantitynumberoptionalpackagingUnitstringoptionalsaleDetailstringoptionalsaleQuantitynumberoptionalsaleUnitstringoptionalsaleTypestringoptionaldefaultTemplateIdstringoptionalisBuyablebooleanrequiredactivebooleanrequiredmainImageIdanyoptionalimagesstring[]requiredproductTypeenumoptionalmanageStockbooleanoptionalstockintegeroptionallowStockThresholdintegeroptionalsoldIndividuallybooleanoptionalweightUnitstringoptionalrequiresLotNumberbooleanoptionalshowOrderDetailsbooleanoptionalisPerishablebooleanoptionalperishabilityDaysintegeroptionaldeliveryDaysintegeroptionalspecificOveragePercentintegeroptionalweightnumberoptionallengthnumberoptionalwidthnumberoptionalheightnumberoptionalpurchaseNotestringoptionalmenuOrderintegeroptionalisGenericbooleanoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/products.createWithAllNeedsCreate With All Needs
Authentification: JWT Bearer requis
Corps de la requête
jsonanyrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/products.deleteAllProductsDelete All Products
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredconfirmationIdstringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/products.deleteGenericLinkDelete Generic Link
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstring · uuidrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/products.deleteProductDelete Product
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/products.getByIdGet By Id
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstringrequiredRéponses
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[]optionaleffectivePricenumberoptionalpriceLabelstringoptionalprestashopActivebooleanoptionalisbnanyoptionalean13anyoptionalupcanyoptionalmpnanyoptionalppomanyoptionalppomNormalizedanyoptionalEntrée (JSON)
GET/api/trpc/products.getBySlugGet By Slug
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredslugstringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/products.getCacheStatusGet Cache Status
Authentification: JWT Bearer requis
Réponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
GET/api/trpc/products.getOrdersByProductIdGet Orders By Product Id
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredproductIdstringrequiredpagenumberrequiredlimitnumberrequiredsortanyoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/products.getProductsByIdsGet Products By Ids
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidsstring[]requiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/products.getProductsGet Products
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequireddefaultVendorIdstringoptionalpagenumberrequiredper_pagenumberrequiredsearchstringoptionalstockFilterstringoptionalcategoryFilterstringoptionalactiveFilterstringoptionalbuyableFilterstringoptionalpriceRangeFilterstringoptionalgenericFilterstringoptionalbundleFilterstringoptionalproductTypeFilterenumoptionalsubscriptionFilterenumoptionalpublicationIdstringoptionalbundleIdstringoptionalsortOrderstringrequiredsortMultipleobject[]optionalfieldstringrequireddirectionenumrequiredexcludeIdsstring[]optionalRéponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
itemsobject[]optionalidstringoptionalreferencestringoptionalplenigoOfferIdanyoptionalplenigoAccessRightUniqueIdanyoptionalnamestringoptionaldescriptionstringoptionalpricenumberoptionalsalePriceanyoptionalproPriceanyoptionalpurchasePricenumberoptionalstockintegeroptionalstockLedgerintegeroptionalisBuyablebooleanoptionalskustringoptionalisGenericbooleanoptionalmagazineEditionIdanyoptionalsiteIdstringoptionalproductTypestringoptionalmanageStockbooleanoptionallowStockThresholdintegeroptionalsoldIndividuallybooleanoptionalweightanyoptionallengthanyoptionalwidthanyoptionalheightanyoptionalpurchaseNoteanyoptionalmenuOrderanyoptionaldataobjectoptionalmanufacturerstringoptionaltaxRatenumberoptionalactivebooleanoptionaldefaultVendorIdstringoptionalpackagingTypeIdstringoptionalpackagingQuantityintegeroptionalpackagingUnitstringoptionalsaleDetailanyoptionalsaleQuantitynumberoptionalsaleUnitstringoptionalsaleTypestringoptionaldefaultTemplateIdanyoptionalapprovisionnementintegeroptionalweightUnitanyoptionalrequiresLotNumberbooleanoptionalshowOrderDetailsbooleanoptionalisPerishablebooleanoptionalperishabilityDaysanyoptionaldeliveryDaysanyoptionalspecificOveragePercentanyoptionalcreatedByIdstringoptionalwarehouseIdanyoptionalexternalIdstringoptionalsyncedAtanyoptionallastSyncedAtanyoptionalsourcestringoptionalmainImageIdanyoptionalcreatedAtstringoptionalupdatedAtstringoptionaltenantIdstringoptionaltagsIdanyoptionalisMaterialbooleanoptionalisFinishedProductbooleanoptionalmanufacturingLeadTimeanyoptionalsafetyStockanyoptionalreorderPointanyoptionalmoqanyoptionalmanufacturingCostanyoptionalsubscriptionEnabledbooleanoptionalsubscriptionDurationDaysanyoptionalstripeProductIdanyoptionalstripePriceIdanyoptionalstripeRecurringPriceIdanyoptionalmainImageanyoptionalpackagingTypeobjectoptionaldefaultVendorobjectoptionalstockAvailabilityany[]optionalmagazineEditionanyoptionalassignedSubCategoriesobject[]optional_countobjectoptionalprestashopActivebooleanoptionaltotalintegeroptionalpageintegeroptionalper_pageintegeroptionalpagesintegeroptionalEntrée (JSON)
GET/api/trpc/products.getVendorOrdersByProductIdGet Vendor Orders By Product Id
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredproductIdstringrequiredpagenumberrequiredlimitnumberrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/products.listGenericLinksList Generic Links
Authentification: JWT Bearer requis
Réponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
GET/api/trpc/products.listList
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredpagenumberrequiredlimitnumberrequiredsearchstringoptionalactivebooleanoptionalisBuyablebooleanoptionalcategoryIdstringoptionalvendorIdstringoptionalpackagingTypeIdstringoptionalsortBystringrequiredsortOrderenumrequiredRéponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
itemsobject[]optionalidstringoptionalreferencestringoptionalplenigoOfferIdanyoptionalplenigoAccessRightUniqueIdanyoptionalnamestringoptionaldescriptionstringoptionalpricenumberoptionalsalePriceintegeroptionalproPriceanyoptionalpurchasePriceintegeroptionalstockintegeroptionalstockLedgerintegeroptionalisBuyablebooleanoptionalskustringoptionalisGenericbooleanoptionalmagazineEditionIdanyoptionalsiteIdstringoptionalproductTypestringoptionalmanageStockbooleanoptionallowStockThresholdanyoptionalsoldIndividuallybooleanoptionalweightanyoptionallengthanyoptionalwidthanyoptionalheightanyoptionalpurchaseNoteanyoptionalmenuOrderanyoptionaldataobjectoptionalmanufacturerstringoptionaltaxRatenumberoptionalactivebooleanoptionaldefaultVendorIdstringoptionalpackagingTypeIdstringoptionalpackagingQuantityintegeroptionalpackagingUnitstringoptionalsaleDetailstringoptionalsaleQuantityintegeroptionalsaleUnitstringoptionalsaleTypestringoptionaldefaultTemplateIdanyoptionalapprovisionnementintegeroptionalweightUnitanyoptionalrequiresLotNumberbooleanoptionalshowOrderDetailsbooleanoptionalisPerishablebooleanoptionalperishabilityDaysanyoptionaldeliveryDaysanyoptionalspecificOveragePercentanyoptionalcreatedByIdstringoptionalwarehouseIdanyoptionalexternalIdstringoptionalsyncedAtstringoptionallastSyncedAtanyoptionalsourcestringoptionalmainImageIdanyoptionalcreatedAtstringoptionalupdatedAtstringoptionaltenantIdstringoptionaltagsIdanyoptionalisMaterialbooleanoptionalisFinishedProductbooleanoptionalmanufacturingLeadTimeanyoptionalsafetyStockanyoptionalreorderPointanyoptionalmoqanyoptionalmanufacturingCostanyoptionalsubscriptionEnabledbooleanoptionalsubscriptionDurationDaysanyoptionalstripeProductIdanyoptionalstripePriceIdanyoptionalstripeRecurringPriceIdanyoptionalmainImageanyoptionalpackagingTypeobjectoptionaldefaultVendorobjectoptionalassignedSubCategoriesany[]optionalvariantsany[]optionaleffectivePricenumberoptionalpriceLabelstringoptionaltotalintegeroptionalpageintegeroptionallimitintegeroptionalpagesintegeroptionalEntrée (JSON)
POST/api/trpc/products.removeSubCategoryFromProductRemove Sub Category From Product
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredproductIdstring · uuidrequiredsubCategoryIdstring · uuidrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/products.syncIndividualProductSync Individual Product
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredproductIdstring · uuidrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/products.syncProductsSync Products
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredoffsetnumberrequiredlimitnumberrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/products.syncProductsStockSync Products Stock
Authentification: JWT Bearer requis
Réponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
POST/api/trpc/products.syncSingleProductStockSync Single Product Stock
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredproductIdstringrequiredexternalIdstringoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/products.updateUpdate
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequirednamestringoptionaldescriptionstringoptionalpricenumberoptionalproPriceanyoptionalreferencestringoptionalmanufacturerstringoptionaltaxRatenumberoptionaldefaultVendorIdstringoptionalpackagingTypeIdstringoptionalpackagingQuantitynumberoptionalpackagingUnitstringoptionalsaleDetailstringoptionalsaleQuantitynumberoptionalsaleUnitstringoptionalsaleTypestringoptionaldefaultTemplateIdstringoptionalisBuyablebooleanoptionalactivebooleanoptionalmainImageIdanyoptionalproductTypeenumoptionalmanageStockbooleanoptionalstockintegeroptionallowStockThresholdintegeroptionalsoldIndividuallybooleanoptionalweightUnitstringoptionalrequiresLotNumberbooleanoptionalshowOrderDetailsbooleanoptionalisPerishablebooleanoptionalperishabilityDaysintegeroptionaldeliveryDaysintegeroptionalspecificOveragePercentintegeroptionalweightnumberoptionallengthnumberoptionalwidthnumberoptionalheightnumberoptionalpurchaseNotestringoptionalmenuOrderintegeroptionalisGenericbooleanoptionalidstring · uuidrequiredskipIndexingbooleanrequiredimagesstring[]optionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/products.updateStripeLinkUpdate Stripe Link
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstring · uuidrequiredstripeProductIdanyoptionalstripePriceIdanyoptionalstripeRecurringPriceIdanyoptionalsubscriptionEnabledbooleanoptionalsubscriptionDurationDaysanyoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/products.updateWithAllNeedsUpdate With All Needs
Authentification: JWT Bearer requis
Corps de la requête
jsonanyrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/products.upsertGenericLinkUpsert Generic Link
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstring · uuidoptionalgenericProductIdstring · uuidrequiredexternalProductIdstringrequiredconversionFactornumberrequiredconversionUnitstringoptionalnotesstringoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
recurringInvoices 10
POST/api/trpc/recurringInvoices.cancelCancel
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstring · uuidrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/recurringInvoices.createCreate
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredclientIdstring · uuidrequiredfrequencyenumrequiredstartDateanyrequiredendDateanyoptionalitemsobject[]requirednamestringrequireddescriptionstringoptionalquantitynumberrequiredunitPricenumberrequiredtaxRatenumberoptionalcurrencystringrequiredlanguagestringrequirednotesstringoptionalfooterstringoptionalpaymentTermsstringoptionalpaymentMethodstringoptionalautoSendbooleanrequiredautoReminderbooleanrequiredpdfTemplatenumberrequiredpdfFormatstringoptionaltaxDetailsobjectoptionaldiscountDetailsobjectoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/recurringInvoices.deleteDelete
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstring · uuidrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/recurringInvoices.getGet
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstring · uuidrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/recurringInvoices.getStatsGet Stats
Authentification: JWT Bearer requis
Réponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
totalintegeroptionalactiveintegeroptionalpausedintegeroptionalcancelledintegeroptionalGET/api/trpc/recurringInvoices.getUpcomingGet Upcoming
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequireddaysAheadnumberrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/recurringInvoices.listList
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredpagenumberrequiredlimitnumberrequiredstatusenumoptionalclientIdstring · uuidoptionalsearchstringoptionalRéponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
itemsany[]optionaltotalintegeroptionalpageintegeroptionallimitintegeroptionaltotalPagesintegeroptionalhasMorebooleanoptionalEntrée (JSON)
POST/api/trpc/recurringInvoices.pausePause
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstring · uuidrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/recurringInvoices.resumeResume
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstring · uuidrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/recurringInvoices.updateUpdate
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstring · uuidrequiredclientIdstring · uuidoptionalfrequencyenumoptionalstartDateanyoptionalendDateanyoptionalitemsobject[]optionalnamestringrequireddescriptionstringoptionalquantitynumberrequiredunitPricenumberrequiredtaxRatenumberoptionalcurrencystringoptionallanguagestringoptionalnotesstringoptionalfooterstringoptionalpaymentTermsstringoptionalpaymentMethodstringoptionalautoSendbooleanoptionalautoReminderbooleanoptionalpdfTemplatenumberoptionalpdfFormatstringoptionaltaxDetailsobjectoptionaldiscountDetailsobjectoptionalstatusenumoptionalisActivebooleanoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
shipping 43
GET/api/trpc/shipping.calculateEUVATCalculate EUVAT
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredamountnumberrequiredfromCountrystringrequiredtoCountrystringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/shipping.calculateShippingRatesCalculate Shipping Rates
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredoriginobjectrequiredpostalCodestringrequiredcountrystringrequireddestinationobjectrequiredpostalCodestringrequiredcountrystringrequiredpackagesobject[]requiredweightnumberrequiredlengthnumberoptionalwidthnumberoptionalheightnumberoptionalcurrencystringrequiredcarrierIdsstring[]optionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/shipping.colissimoCreateLabelColissimo Create Label
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredshipmentIdstring · uuidrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/shipping.colissimoGetRatesColissimo Get Rates
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredoriginobjectrequiredpostalCodestringrequiredcountrystringrequireddestinationobjectrequiredpostalCodestringrequiredcountrystringrequiredweightnumberrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/shipping.colissimoSearchPickupPointsColissimo Search Pickup Points
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredaddressstringrequiredpostalCodestringrequiredcitystringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/shipping.colissimoTrackShipmentColissimo Track Shipment
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredtrackingNumberstringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/shipping.createRateCreate Rate
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredcarrierIdstring · uuidrequiredserviceIdstring · uuidrequiredzoneIdstring · uuidrequirednamestringoptionaltypeenumrequiredweightMinnumberrequiredweightMaxnumberrequiredbaseRatenumberrequiredperKgRatenumberoptionalvolumeMinnumberoptionalvolumeMaxnumberoptionalperVolumeRatenumberoptionalhandlingFeenumberoptionalfuelSurchargenumberoptionalinsuranceFeenumberoptionalcorsicaSurchargenumberoptionaldomTomSurchargenumberoptionalruralSurchargenumberoptionalpickupPointDiscountnumberoptionalvatRatenumberrequiredvatIncludedbooleanrequiredisActivebooleanrequiredvalidFromanyoptionalvalidToanyoptionalminOrderValuenumberoptionalmaxOrderValuenumberoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/shipping.createServiceCreate Service
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredcarrierIdstring · uuidrequirednamestringrequiredcodestringrequiredtypeenumrequireddescriptionstringoptionalestimatedDaysMinintegerrequiredestimatedDaysMaxintegerrequiredtrackingIncludedbooleanrequiredinsuranceIncludedbooleanrequiredsignatureRequiredbooleanrequiredisActivebooleanrequiredavailableZonesstring[]requiredpickupPointServicebooleanrequiredappointmentRequiredbooleanrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/shipping.createShipmentCreate Shipment
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredorderIdstring · uuidrequiredcarrierIdstring · uuidrequiredserviceIdstring · uuidrequiredpickupPointIdstring · uuidoptionalpackagesobject[]requiredweightnumberrequiredlengthnumberoptionalwidthnumberoptionalheightnumberoptionalsenderAddressobjectrequiredrecipientAddressobjectrequiredcurrencystringrequiredinstructionsstringoptionalrequiresSignaturebooleanrequiredinsuranceValuenumberoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/shipping.createShippingCarrierCreate Shipping Carrier
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequirednamestringrequiredcodestringrequireddescriptionstringoptionallogoUrlstring · urioptionalwebsiteUrlstring · urioptionalstatusenumrequiredpriorityintegerrequiredapiEndpointstring · urioptionalapiKeystringoptionalapiSecretstringoptionaltestModebooleanrequiredcountryCodestringrequiredeuCoveragebooleanrequiredinternationalCoveragebooleanrequiredpickupPointsSupportedbooleanrequiredtrackingSupportedbooleanrequiredlabelGenerationSupportedbooleanrequiredcorsicaSupportedbooleanrequireddomTomSupportedbooleanrequiredappointmentDeliverybooleanrequiredmaxWeightnumberoptionalmaxLengthnumberoptionalmaxWidthnumberoptionalmaxHeightnumberoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/shipping.createZoneCreate Zone
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequirednamestringrequiredcodestringrequiredtypeenumrequireddescriptionstringoptionalcountriesstring[]requiredregionsstring[]requiredpostalCodeRangesobjectoptionalincludesCorsicabooleanrequiredincludesDomTombooleanrequiredruralDeliveryHandlingbooleanrequiredisActivebooleanrequiredpriorityintegerrequiredfreeShippingThresholdnumberoptionalmaxWeightnumberoptionalmaxDimensionsobjectoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/shipping.deleteRateDelete Rate
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredrateIdstring · uuidrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/shipping.deleteServiceDelete Service
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredserviceIdstring · uuidrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/shipping.deleteShippingCarrierDelete Shipping Carrier
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredcarrierIdstring · uuidrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/shipping.deleteZoneDelete Zone
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredzoneIdstring · uuidrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/shipping.generateBulkLabelsGenerate Bulk Labels
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredshipmentIdsstring[]requiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/shipping.generateLabelGenerate Label
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredshipmentIdstring · uuidrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/shipping.getCarrierGet Carrier
Authentification: JWT Bearer requis
Réponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
idstringoptionalcarrierIdstringoptionaltenantIdstringoptionalsiteIdstringoptionalnamestringoptionalcodestringoptionaltypestringoptionaldescriptionstringoptionalestimatedDaysMinintegeroptionalestimatedDaysMaxintegeroptionaltrackingIncludedbooleanoptionalinsuranceIncludedbooleanoptionalsignatureRequiredbooleanoptionalisActivebooleanoptionalavailableZonesstring[]optionalpickupPointServicebooleanoptionalappointmentRequiredbooleanoptionalcreatedAtstringoptionalupdatedAtstringoptionalcarrierobjectoptionalidstringoptionalnamestringoptionalcodestringoptionalratesobject[]optionalidstringoptionaltenantIdstringoptionalsiteIdstringoptionalcarrierIdstringoptionalserviceIdstringoptionalzoneIdstringoptionalnamestringoptionaltypestringoptionalweightMinstringoptionalweightMaxstringoptionalbaseRatestringoptionalperKgRatestringoptionalvolumeMinanyoptionalvolumeMaxanyoptionalperVolumeRateanyoptionalhandlingFeestringoptionalfuelSurchargestringoptionalinsuranceFeestringoptionalcorsicaSurchargestringoptionaldomTomSurchargestringoptionalruralSurchargestringoptionalpickupPointDiscountstringoptionalvatRatestringoptionalvatIncludedbooleanoptionalisActivebooleanoptionalvalidFromstringoptionalvalidToanyoptionalminOrderValuestringoptionalmaxOrderValueanyoptionalcreatedAtstringoptionalupdatedAtstringoptionalzoneobjectoptionalGET/api/trpc/shipping.getCostAnalysisGet Cost Analysis
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredstartDateanyrequiredendDateanyrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/shipping.getDeliveryPerformanceGet Delivery Performance
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredstartDateanyrequiredendDateanyrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/shipping.getPerformanceDashboardGet Performance Dashboard
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredstartDateanyrequiredendDateanyrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/shipping.getPickupPointsGet Pickup Points
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredcarrierIdstring · uuidrequiredaddressstringrequiredpostalCodestringrequiredcitystringrequiredcountrystringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/shipping.getPrintJobsGet Print Jobs
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredpageintegerrequiredlimitintegerrequiredRéponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
successbooleanoptionalprintJobsany[]optionaltotalintegeroptionalhasMorebooleanoptionalEntrée (JSON)
GET/api/trpc/shipping.getQuickEstimateGet Quick Estimate
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredweightnumberrequiredcarrierIdstring · uuidoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/shipping.getRatesGet Rates
Authentification: JWT Bearer requis
Réponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
idstringoptionaltenantIdstringoptionalsiteIdstringoptionalcarrierIdstringoptionalserviceIdstringoptionalzoneIdstringoptionalnamestringoptionaltypestringoptionalweightMinstringoptionalweightMaxstringoptionalbaseRatestringoptionalperKgRatestringoptionalvolumeMinanyoptionalvolumeMaxanyoptionalperVolumeRateanyoptionalhandlingFeestringoptionalfuelSurchargestringoptionalinsuranceFeestringoptionalcorsicaSurchargestringoptionaldomTomSurchargestringoptionalruralSurchargestringoptionalpickupPointDiscountstringoptionalvatRatestringoptionalvatIncludedbooleanoptionalisActivebooleanoptionalvalidFromstringoptionalvalidToanyoptionalminOrderValuestringoptionalmaxOrderValueanyoptionalcreatedAtstringoptionalupdatedAtstringoptionalzoneobjectoptionalidstringoptionalnamestringoptionalcountriesstring[]optionalserviceobjectoptionalidstringoptionalnamestringoptionaltypestringoptionalcarrierobjectoptionalGET/api/trpc/shipping.getShipmentGet Shipment
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredshipmentIdstring · uuidrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/shipping.getShipmentsGet Shipments
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredpageintegerrequiredlimitintegerrequiredstatusstringoptionalcarrierIdstring · uuidoptionaldateFromanyoptionaldateToanyoptionalsearchstringoptionalRéponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
shipmentsany[]optionaltotalintegeroptionalpageintegeroptionallimitintegeroptionalhasMorebooleanoptionalEntrée (JSON)
GET/api/trpc/shipping.getShippingAnalyticsGet Shipping Analytics
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredstartDateanyrequiredendDateanyrequiredcarrierIdstring · uuidoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/shipping.getShippingCarriersGet Shipping Carriers
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredincludeInactivebooleanrequiredRéponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
idstringoptionaltenantIdstringoptionalsiteIdstringoptionalnamestringoptionalcodestringoptionaldescriptionstringoptionallogoUrlanyoptionalwebsiteUrlanyoptionalstatusstringoptionalpriorityintegeroptionalapiEndpointanyoptionalapiKeyanyoptionalapiSecretanyoptionaltestModebooleanoptionalcountryCodestringoptionaleuCoveragebooleanoptionalinternationalCoveragebooleanoptionalpickupPointsSupportedbooleanoptionaltrackingSupportedbooleanoptionallabelGenerationSupportedbooleanoptionalcorsicaSupportedbooleanoptionaldomTomSupportedbooleanoptionalappointmentDeliverybooleanoptionalmaxWeightstringoptionalmaxLengthanyoptionalmaxWidthanyoptionalmaxHeightanyoptionalcreatedAtstringoptionalupdatedAtstringoptionalservicesobject[]optionalidstringoptionalnamestringoptionaltypestringoptionalEntrée (JSON)
GET/api/trpc/shipping.getShippingConfigurationGet Shipping Configuration
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredincludeInactivebooleanrequiredRéponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
idstringoptionaltenantIdstringoptionalsiteIdstringoptionalnamestringoptionalcodestringoptionaldescriptionstringoptionallogoUrlanyoptionalwebsiteUrlanyoptionalstatusstringoptionalpriorityintegeroptionalapiEndpointanyoptionalapiKeyanyoptionalapiSecretanyoptionaltestModebooleanoptionalcountryCodestringoptionaleuCoveragebooleanoptionalinternationalCoveragebooleanoptionalpickupPointsSupportedbooleanoptionaltrackingSupportedbooleanoptionallabelGenerationSupportedbooleanoptionalcorsicaSupportedbooleanoptionaldomTomSupportedbooleanoptionalappointmentDeliverybooleanoptionalmaxWeightstringoptionalmaxLengthanyoptionalmaxWidthanyoptionalmaxHeightanyoptionalcreatedAtstringoptionalupdatedAtstringoptionalservicesobject[]optionalidstringoptionalnamestringoptionaltypestringoptionalEntrée (JSON)
GET/api/trpc/shipping.getShippingZonesGet Shipping Zones
Authentification: JWT Bearer requis
Réponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
idstringoptionaltenantIdstringoptionalsiteIdstringoptionalnamestringoptionalcodestringoptionaltypestringoptionaldescriptionstringoptionalcountriesstring[]optionalregionsany[]optionalpostalCodeRangesanyoptionalincludesCorsicabooleanoptionalincludesDomTombooleanoptionalruralDeliveryHandlingbooleanoptionalisActivebooleanoptionalpriorityintegeroptionalfreeShippingThresholdstringoptionalmaxWeightstringoptionalmaxDimensionsanyoptionalcreatedAtstringoptionalupdatedAtstringoptional_countobjectoptionalratesintegeroptionalGET/api/trpc/shipping.getZonesGet Zones
Authentification: JWT Bearer requis
Réponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
idstringoptionaltenantIdstringoptionalsiteIdstringoptionalnamestringoptionalcodestringoptionaltypestringoptionaldescriptionstringoptionalcountriesstring[]optionalregionsany[]optionalpostalCodeRangesanyoptionalincludesCorsicabooleanoptionalincludesDomTombooleanoptionalruralDeliveryHandlingbooleanoptionalisActivebooleanoptionalpriorityintegeroptionalfreeShippingThresholdstringoptionalmaxWeightstringoptionalmaxDimensionsanyoptionalcreatedAtstringoptionalupdatedAtstringoptional_countobjectoptionalratesintegeroptionalGET/api/trpc/shipping.performComplianceCheckPerform Compliance Check
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredshipmentIdstring · uuidrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/shipping.processBulkOrdersProcess Bulk Orders
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredorderIdsstring[]requiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/shipping.searchPickupPointsSearch Pickup Points
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredsiteSlugstringrequiredaddressstringrequiredmaxResultsintegerrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/shipping.sendShippingNotificationSend Shipping Notification
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredshipmentIdstring · uuidrequiredtypeenumrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/shipping.updateCarrierRatesUpdate Carrier Rates
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredcarrierIdstring · uuidrequiredratesobject[]requiredcarrierIdstring · uuidrequiredserviceIdstring · uuidrequiredzoneIdstring · uuidrequirednamestringoptionaltypeenumrequiredweightMinnumberrequiredweightMaxnumberrequiredbaseRatenumberrequiredperKgRatenumberoptionalvolumeMinnumberoptionalvolumeMaxnumberoptionalperVolumeRatenumberoptionalhandlingFeenumberoptionalfuelSurchargenumberoptionalinsuranceFeenumberoptionalcorsicaSurchargenumberoptionaldomTomSurchargenumberoptionalruralSurchargenumberoptionalpickupPointDiscountnumberoptionalvatRatenumberrequiredvatIncludedbooleanrequiredisActivebooleanrequiredvalidFromanyoptionalvalidToanyoptionalminOrderValuenumberoptionalmaxOrderValuenumberoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/shipping.updateRateUpdate Rate
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredcarrierIdstring · uuidoptionalserviceIdstring · uuidoptionalzoneIdstring · uuidoptionalnamestringoptionaltypeenumoptionalweightMinnumberoptionalweightMaxnumberoptionalbaseRatenumberoptionalperKgRatenumberoptionalvolumeMinnumberoptionalvolumeMaxnumberoptionalperVolumeRatenumberoptionalhandlingFeenumberoptionalfuelSurchargenumberoptionalinsuranceFeenumberoptionalcorsicaSurchargenumberoptionaldomTomSurchargenumberoptionalruralSurchargenumberoptionalpickupPointDiscountnumberoptionalvatRatenumberoptionalvatIncludedbooleanoptionalisActivebooleanoptionalvalidFromanyoptionalvalidToanyoptionalminOrderValuenumberoptionalmaxOrderValuenumberoptionalrateIdstring · uuidrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/shipping.updateServiceUpdate Service
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredcarrierIdstring · uuidoptionalnamestringoptionalcodestringoptionaltypeenumoptionaldescriptionstringoptionalestimatedDaysMinintegeroptionalestimatedDaysMaxintegeroptionaltrackingIncludedbooleanoptionalinsuranceIncludedbooleanoptionalsignatureRequiredbooleanoptionalisActivebooleanoptionalavailableZonesstring[]optionalpickupPointServicebooleanoptionalappointmentRequiredbooleanoptionalserviceIdstring · uuidrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/shipping.updateShippingCarrierUpdate Shipping Carrier
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequirednamestringoptionalcodestringoptionaldescriptionstringoptionallogoUrlstring · urioptionalwebsiteUrlstring · urioptionalstatusenumoptionalpriorityintegeroptionalapiEndpointstring · urioptionalapiKeystringoptionalapiSecretstringoptionaltestModebooleanoptionalcountryCodestringoptionaleuCoveragebooleanoptionalinternationalCoveragebooleanoptionalpickupPointsSupportedbooleanoptionaltrackingSupportedbooleanoptionallabelGenerationSupportedbooleanoptionalcorsicaSupportedbooleanoptionaldomTomSupportedbooleanoptionalappointmentDeliverybooleanoptionalmaxWeightnumberoptionalmaxLengthnumberoptionalmaxWidthnumberoptionalmaxHeightnumberoptionalcarrierIdstring · uuidrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/shipping.updateZoneUpdate Zone
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequirednamestringoptionalcodestringoptionaltypeenumoptionaldescriptionstringoptionalcountriesstring[]optionalregionsstring[]optionalpostalCodeRangesobjectoptionalincludesCorsicabooleanoptionalincludesDomTombooleanoptionalruralDeliveryHandlingbooleanoptionalisActivebooleanoptionalpriorityintegeroptionalfreeShippingThresholdnumberoptionalmaxWeightnumberoptionalmaxDimensionsobjectoptionalzoneIdstring · uuidrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/shipping.validateAddressValidate Address
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredaddressobjectrequiredstreetstringrequiredcitystringrequiredpostalCodestringrequiredcountrystringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/shipping.validateCarrierAPIValidate Carrier API
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredcarrierIdstring · uuidrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
subscriptions 2
GET/api/trpc/subscriptions.cancelCancel
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredsubscriptionIdstring · uuidrequirednewAmountnumberrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/subscriptions.createCreate
Authentification: JWT Bearer requis
Réponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
tiers 29
GET/api/trpc/tiers.checkTiersExistenceCheck Tiers Existence
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredcriteriaobjectrequiredsiretstringoptionalsirenstringoptionalemailstring · emailoptionalnamestringoptionalRéponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
existsbooleanoptionaltiersanyoptionalmatchesany[]optionalEntrée (JSON)
POST/api/trpc/tiers.createActivityCreate Activity
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredtiersIdstring · uuidrequiredtypeenumrequiredsubjectstringrequireddescriptionstringoptionalscheduledAtanyoptionalcontactIdstring · uuidoptionalopportunityIdstring · uuidoptionaleventIdstring · uuidoptionalpriorityenumrequiredmetadataobjectoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/tiers.createAddressCreate Address
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredtiersIdstring · uuidrequiredtypeenumrequirednamestringoptionalstreetstringrequiredstreet2stringoptionalcitystringrequiredpostalCodestringrequiredcountrystringrequiredregionstringoptionallatitudenumberoptionallongitudenumberoptionalisDefaultbooleanrequiredisActivebooleanrequiredmetadataobjectoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/tiers.createContactCreate Contact
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredtiersIdstring · uuidrequiredfirstNamestringrequiredlastNamestringrequiredemailstring · emailoptionalphonestringoptionalmobilestringoptionalrolestringoptionaltitlestringoptionaldepartmentstringoptionalisPrimarybooleanrequiredtagsstring[]optionalmetadataobjectoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/tiers.createCustomFieldCreate Custom Field
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/tiers.createOpportunityCreate Opportunity
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredtiersIdstring · uuidrequirednamestringrequireddescriptionstringoptionalstatusenumoptionalsourceenumoptionalstagestringoptionalvaluenumberoptionalprobabilitynumberrequiredexpectedCloseDateanyoptionalprimaryContactIdstring · uuidoptionalassignedToIdstring · uuidrequiredlostReasonstringoptionalcompetitorInfostringoptionalnextActionstringoptionalnextActionDateanyoptionalmetadataobjectoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/tiers.createTiersCreate Tiers
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequirednamestringrequiredemailstring · emailoptionalphonestringoptionalsiretstringoptionalsirenstringoptionaltvastringoptionaltypeenumrequiredstatusenumrequiredindustrystringoptionalcompanySizestringoptionalannualRevenuestringoptionalwebsitestring · urioptionaldescriptionstringoptionalcreditLimitnumberoptionalcreditUsednumberoptionalpaymentTermsstringoptionalpreferredCurrencyenumrequiredtaxExemptbooleanrequiredcreditScorenumberoptionalriskLevelenumoptionaltagsstring[]optionalmetadataobjectoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/tiers.deleteTiersDelete Tiers
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstring · uuidrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/tiers.getActivitiesGet Activities
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredtiersIdstring · uuidoptionalcontactIdstring · uuidoptionaltypestring[]optionalstatusstring[]optionalprioritystring[]optionaldateFromanyoptionaldateToanyoptionalassignedToIdstring · uuidoptionalpagenumberrequiredlimitnumberrequiredsortByenumrequiredsortOrderenumrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/tiers.getAllTiersGet All Tiers
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredpagenumberrequiredlimitnumberrequiredsearchstringoptionaltypeenumoptionalstatusenumoptionalsortByenumrequiredsortOrderenumrequiredRéponses
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[]optionaltotalintegeroptionalpageintegeroptionallimitintegeroptionalhasMorebooleanoptionalEntrée (JSON)
GET/api/trpc/tiers.getFinancialsByTiersExternalIdsGet Financials By Tiers External Ids
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredexternalIdsstring[]requiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/tiers.getOpportunitiesGet Opportunities
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredtiersIdstring · uuidoptionalstatusstring[]optionalstagestring[]optionalassignedToIdstring · uuidoptionalvalueMinnumberoptionalvalueMaxnumberoptionalprobabilityMinnumberoptionalprobabilityMaxnumberoptionalexpectedCloseFromanyoptionalexpectedCloseToanyoptionalpagenumberrequiredlimitnumberrequiredsortByenumrequiredsortOrderenumrequiredRéponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
opportunitiesany[]optionaltotalintegeroptionalpageintegeroptionallimitintegeroptionalhasMorebooleanoptionalsummaryanyoptionalEntrée (JSON)
GET/api/trpc/tiers.getTiersActivitiesByIdGet Tiers Activities By Id
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstring · uuidrequiredpagenumberrequiredlimitnumberrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/tiers.getTiersByIdGet Tiers By Id
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstring · uuidrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/tiers.getTiersByIdsGet Tiers By Ids
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidsstring[]requiredRéponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
tiersany[]optionaltotalintegeroptionalEntrée (JSON)
GET/api/trpc/tiers.getTiersByRefGet Tiers By Ref
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredrefstringrequiredRéponses
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[]optionalEntrée (JSON)
GET/api/trpc/tiers.getTiersBySiretGet Tiers By Siret
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredsiretstringrequiredRéponses
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_groupintegeroptionalgeocodeanyoptionaladdressL1stringoptionaladdressL2stringoptionaladdressCPstringoptionaladdressCommunestringoptionaladdressDepartementstringoptionallatitudeanyoptionallongitudeanyoptionaluserIdstringoptionalcreatedByIdstringoptionalassignedToIdanyoptionaltenantIdstringoptionalsiteIdstringoptionallastSyncedAtanyoptionalaccountManagerIdanyoptionalannualRevenueanyoptionalaverageOrderValuestringoptionalcompanySizeanyoptionalcreditCheckDateanyoptionalcreditLimitanyoptionalcreditScoreanyoptionalcreditUsedstringoptionalfirstOrderDateanyoptionalindustryanyoptionallanguagestringoptionallastOrderDateanyoptionallastQualificationDateanyoptionalleadScoreintegeroptionallifetimeValuestringoptionaloutstandingBalancestringoptionalparentCompanyIdanyoptionalpartnerTypeanyoptionalpaymentTermsanyoptionalpreferredContactMethodstringoptionalpreferredCurrencystringoptionalqualificationNotesanyoptionalqualificationStatusanyoptionalsocialMediaUrlsanyoptionaltaxExemptbooleanoptionaltimezoneanyoptionaltotalRevenuestringoptionalwebsiteanyoptionalEntrée (JSON)
GET/api/trpc/tiers.getTiersContactsByIdGet Tiers Contacts By Id
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstring · uuidrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/tiers.getTiersEnhancedGet Tiers Enhanced
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstring · uuidrequiredincludeContactsbooleanrequiredincludeAddressesbooleanrequiredincludeActivitiesbooleanrequiredincludeOpportunitiesbooleanrequiredincludeFinancialsbooleanrequiredincludeFilesbooleanrequiredactivityLimitnumberrequiredopportunityLimitnumberrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/tiers.getTiersFilesByIdGet Tiers Files By Id
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstring · uuidrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/tiers.getTiersGet Tiers
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredpagenumberrequiredlimitnumberrequiredsearchstringoptionalfiltersobjectoptionaltypestring[]optionalstatusstring[]optionalindustrystring[]optionaltagsstring[]optionalhasCreditbooleanoptionalcreditRiskenumoptionalsortByenumrequiredsortOrderenumrequiredincludeContactsbooleanrequiredincludeFinancialsbooleanrequiredRéponses
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[]optionaltotalintegeroptionalpageintegeroptionallimitintegeroptionalhasMorebooleanoptionalsummaryanyoptionalEntrée (JSON)
POST/api/trpc/tiers.linkContactLink Contact
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredtiersIdstring · uuidrequiredcontactIdstring · uuidrequiredrolestringoptionalisPrimarybooleanrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/tiers.searchAndExportTiersSearch And Export Tiers
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredsearchstringoptionalfiltersobjectoptionaltypestring[]optionalstatusstring[]optionalindustrystring[]optionaltagsstring[]optionalcreditScoreMinnumberoptionalcreditScoreMaxnumberoptionalcreatedFromanyoptionalcreatedToanyoptionalsortByenumrequiredsortOrderenumrequiredpagenumberrequiredlimitnumberrequiredexportbooleanrequiredexportFormatenumrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/tiers.toggleTiersStatusToggle Tiers Status
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstring · uuidrequiredstatusenumrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/tiers.unlinkContactUnlink Contact
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredtiersIdstring · uuidrequiredcontactIdstring · uuidrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/tiers.updateActivityUpdate Activity
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredtiersIdstring · uuidoptionaltypeenumoptionalsubjectstringoptionaldescriptionstringoptionalscheduledAtanyoptionalcontactIdstring · uuidoptionalopportunityIdstring · uuidoptionaleventIdstring · uuidoptionalpriorityenumoptionalmetadataobjectoptionalidstring · uuidoptionalstatusenumoptionaloutcomestringoptionalnotesstringoptionalcompletedAtanyoptionaldurationnumberoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/tiers.updateFinancialInfoUpdate Financial Info
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredtiersIdstring · uuidrequiredfinancialDataobjectrequiredtotalRevenuenumberoptionaloutstandingBalancenumberoptionalaverageOrderValuenumberoptionallifetimeValuenumberoptionalcreditLimitnumberoptionalcreditUsednumberoptionalpaymentTermsstringoptionalcreditScorenumberoptionalriskLevelenumoptionallastPaymentDateanyoptionalfirstOrderDateanyoptionallastOrderDateanyoptionalpaymentConditionanyoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/tiers.updateOpportunityUpdate Opportunity
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredtiersIdstring · uuidoptionalnamestringoptionaldescriptionstringoptionalstatusenumoptionalsourceenumoptionalstagestringoptionalvaluenumberoptionalprobabilitynumberoptionalexpectedCloseDateanyoptionalprimaryContactIdstring · uuidoptionalassignedToIdstring · uuidoptionallostReasonstringoptionalcompetitorInfostringoptionalnextActionstringoptionalnextActionDateanyoptionalmetadataobjectoptionalidstring · uuidoptionalactualCloseDateanyoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/tiers.updateTiersUpdate Tiers
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstring · uuidrequiredupdatesobjectrequirednamestringoptionalemailstring · emailoptionalphonestringoptionalsiretstringoptionalsirenstringoptionaltvastringoptionaltypeenumoptionalstatusenumoptionalindustrystringoptionalcompanySizestringoptionalannualRevenuestringoptionalwebsitestring · urioptionaldescriptionstringoptionalcreditLimitnumberoptionalcreditUsednumberoptionalpaymentTermsstringoptionalpreferredCurrencyenumoptionaltaxExemptbooleanoptionalcreditScorenumberoptionalriskLevelenumoptionaltagsstring[]optionalmetadataobjectoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
users 20
GET/api/trpc/users.checkUserSiteAccessCheck User Site Access
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredsiteIdstringrequiredRéponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
hasAccessbooleanoptionaluserSiteIdstringoptionalrequestedSiteIdstringoptionalisSuperAdminbooleanoptionalEntrée (JSON)
POST/api/trpc/users.createUserForSiteCreate User For Site
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredfirstNamestringrequiredlastNamestringrequiredemailstring · emailrequiredrolesstring[]requiredphonestringoptionaltitlestringoptionaltenantIdstringoptionalsiteIdstringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/users.createUserCreate User
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredfirstNamestringrequiredlastNamestringrequiredemailstring · emailrequiredrolesstring[]requiredphonestringoptionaltitlestringoptionaltenantIdstringoptionalsiteIdstringoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/users.deleteUserDelete User
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequireduserIdstringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/users.deleteUsersDelete Users
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequireduserIdsstring[]requiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/users.forgotPasswordForgot Password
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredemailstring · emailrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/users.getAnonymousMeilisearchCredentialsGet Anonymous Meilisearch Credentials
Authentification: JWT Bearer requis
Réponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
GET/api/trpc/users.getAuthoredArticlesGet Authored Articles
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequireduserIdstring · uuidrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/users.getServerUsersGet Server Users
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredtenantIdstringoptionalsiteIdstringoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/users.getUserDetailsGet User Details
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequireduserIdstringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/users.getUserGet User
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstringrequiredRéponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
idstringoptionalupdatedAtstringoptionalcreatedAtstringoptionalemailVerifiedstringoptionalblockedbooleanoptionalnamestringoptionalemailstringoptionalfirstNameanyoptionallastNameanyoptionaltitleanyoptionalpasswordstringoptionalphoneanyoptionalimageanyoptionaldataobjectoptionalmenuAllowliststring[]optionalresetTokenanyoptionalresetTokenExpiryanyoptionalemailVerificationTokenanyoptionalemailVerificationTokenExpiryanyoptionalsuperiorIdanyoptionalsiteIdstringoptionaltenantIdstringoptionalcanAccessReportsbooleanoptionalcanManageCashbooleanoptionalcanSupervisorOverridebooleanoptionalcanVoidTransactionsbooleanoptionalcurrentShiftStartanyoptionalemployeeNumberanyoptionalisClockedInbooleanoptionalmaxDiscountPercentintegeroptionalposPermissionsanyoptionalposPinanyoptionalposRolestringoptionalEntrée (JSON)
GET/api/trpc/users.getUserProfileGet User Profile
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequireduserIdstringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/users.getUserRolesGet User Roles
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequireduserIdstringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
GET/api/trpc/users.getUsersGet Users
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredpagenumberrequiredper_pagenumberrequiredsearchstringoptionalsortstringoptionaladvancedSortsobject[]optionalfieldstringrequireddirectionenumrequiredadvancedFiltersobjectoptionalfiltersobjectoptionalhidden_columnsstring[]optionaltenantIdstringoptionalsiteIdstringoptionalRéponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
dataobject[]optionalidstringoptionalupdatedAtstringoptionalcreatedAtstringoptionalemailVerifiedstringoptionalblockedbooleanoptionalnamestringoptionalemailstringoptionalfirstNamestringoptionallastNamestringoptionaltitleanyoptionalpasswordstringoptionalphoneanyoptionalimageanyoptionaldataobjectoptionalresetTokenanyoptionalresetTokenExpiryanyoptionalemailVerificationTokenanyoptionalemailVerificationTokenExpiryanyoptionalsuperiorIdanyoptionalsiteIdstringoptionaltenantIdstringoptionalcanAccessReportsbooleanoptionalcanManageCashbooleanoptionalcanSupervisorOverridebooleanoptionalcanVoidTransactionsbooleanoptionalcurrentShiftStartanyoptionalemployeeNumberanyoptionalisClockedInbooleanoptionalmaxDiscountPercentintegeroptionalposPermissionsanyoptionalposPinanyoptionalposRolestringoptionaltenantobjectoptionalsiteobjectoptionalrolesobject[]optionalfullNamestringoptionalroleNamesstringoptionalstatusstringoptionalisAdminbooleanoptionalprimaryRolestringoptionalpaginationobjectoptionalpageintegeroptionalper_pageintegeroptionaltotalintegeroptionaltotal_pagesintegeroptionalEntrée (JSON)
GET/api/trpc/users.listList
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredsearchstringoptionallimitnumberrequiredtenantIdstringoptionalsiteIdstringoptionalonlyAuthorsbooleanoptionalRéponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
idstringoptionalnamestringoptionalemailstringoptionalimageanyoptionalEntrée (JSON)
GET/api/trpc/users.listMyUsersList My Users
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredpagenumberrequiredper_pagenumberrequiredsearchstringoptionalsortstringoptionaladvancedSortsobject[]optionalfieldstringrequireddirectionenumrequiredadvancedFiltersobjectoptionalfiltersobjectoptionalhidden_columnsstring[]optionalRéponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
dataobject[]optionalidstringoptionalupdatedAtstringoptionalcreatedAtstringoptionalemailVerifiedstringoptionalblockedbooleanoptionalnamestringoptionalemailstringoptionalfirstNamestringoptionallastNamestringoptionaltitleanyoptionalpasswordstringoptionalphoneanyoptionalimageanyoptionaldataobjectoptionalresetTokenanyoptionalresetTokenExpiryanyoptionalemailVerificationTokenanyoptionalemailVerificationTokenExpiryanyoptionalsuperiorIdanyoptionalsiteIdstringoptionaltenantIdstringoptionalcanAccessReportsbooleanoptionalcanManageCashbooleanoptionalcanSupervisorOverridebooleanoptionalcanVoidTransactionsbooleanoptionalcurrentShiftStartanyoptionalemployeeNumberanyoptionalisClockedInbooleanoptionalmaxDiscountPercentintegeroptionalposPermissionsanyoptionalposPinanyoptionalposRolestringoptionaltenantobjectoptionalsiteobjectoptionalrolesobject[]optionalfullNamestringoptionalroleNamesstringoptionalstatusstringoptionalisAdminbooleanoptionalprimaryRolestringoptionalpaginationobjectoptionalpageintegeroptionalper_pageintegeroptionaltotalintegeroptionaltotal_pagesintegeroptionalEntrée (JSON)
POST/api/trpc/users.resetPasswordWithTokenReset Password With Token
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredtokenstringrequiredpasswordstringrequiredRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/users.sendPasswordResetEmailSend Password Reset Email
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredemailstring · emailrequiredtenantIdstring · uuidoptionalsiteIdstring · uuidoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/users.updateUserUpdate User
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredidstringrequirednamestringoptionalfirstNamestringoptionallastNamestringoptionalemailstring · emailoptionaltitlestringoptionalphonestringoptionalimagestringoptionalblockedbooleanoptionalemailVerifiedanyoptionalroleIdsstring[]optionaldataobjectoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)
POST/api/trpc/users.updateUserProfileUpdate User Profile
Authentification: JWT Bearer requis
Corps de la requête
jsonobjectrequiredfirstNamestringrequiredlastNamestringrequiredphonestringoptionalemailstring · emailrequiredcompanyNamestringoptionaladdressstringoptionalbiostringoptionaltwitterUrlstringoptionallinkedinUrlstringoptionalwebsitestringoptionaluserIdstringoptionalRéponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Entrée (JSON)