API Explorer
Every procedure of the Inklura platform API, grouped by router. Each entry shows the method, the expected input and the response. With your credentials you can copy a ready-to-run cURL or send the request from this page.
Note
Each operation is a tRPC procedure called at /api/trpc/<router>.<procedure>: mutations via POST (body {"json": <input>}), queries via GET (?input= followed by the same object, URL-encoded). The input shown is that json value; responses come back as {"result":{"data":{"json": …}}}. Requests authenticate with a Bearer JWT. See the tRPC guide.
Server: https://manage.inklura.fr · 307 operations · Download the full OpenAPI specification
Credentials & contextKept in your browser. The token is forgotten when the tab closes unless you tick "Remember".
Opens the Inklura console: sign in the way you usually do (password, invitation link, SSO), then authorize the explorer. The token comes straight back here.
Or paste an existing token
No operation matches this filter.
auth 12
POST/api/trpc/auth.bridgeOidcBridge Oidc
Input
substringrequired≥ 1 chars
emailstring · emailrequiredfirstNamestring | nulloptionallastNamestring | nulloptionalnamestring | nulloptionalResponse
200 Success. The result is in
result.data.json : objectuserIdstringrequiredemailstringrequiredfirstNamestringrequiredlastNamestringrequirednamestringrequiredroleenumrequired"particulier" "pro"proStatusenumoptional"pending" "active" "refused"tenantIdstringrequiredsiteIdstringrequiredTry it
GET/api/trpc/auth.canAccessManageCan Access Manage
Input
No input.
Response
200 Success. The result is in
result.data.json : objectallowedbooleanrequiredTry it
GET/api/trpc/auth.getProfileGet Profile
Input
No input.
Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/auth.getSecretMessageGet Secret Message
GET/api/trpc/auth.getSessionGet Session
Input
No input.
Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/auth.getUserInfoGet User Info
Input
emailstringrequiredResponse
200 Success. The result is in
result.data.json : objectinputstringrequiredokbooleanrequireduseranyrequiredTry it
POST/api/trpc/auth.loginLogin
Input
emailstring · emailrequiredpasswordstringrequired≥ 1 chars
sitestringoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/auth.registerRegister
Input
emailstring · emailrequiredpasswordstringrequired≥ 8 chars
confirmPasswordstringrequired≥ 1 chars
firstNamestringrequired≥ 2 chars
lastNamestringrequired≥ 2 chars
isArchitectbooleanoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/auth.requestPasswordResetRequest Password Reset
Input
emailstring · emailrequiredResponse
200 Success. The result is in
result.data.json : objectsuccessbooleanrequiredmessagestringrequiredTry it
POST/api/trpc/auth.resendVerificationEmailResend Verification Email
Input
No input.
Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/auth.signupSignup
Input
emailstring · emailrequiredpasswordstringrequired≥ 8 chars
firstNamestringrequired≥ 1 chars
lastNamestringrequired≥ 1 chars
Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/auth.verifyEmailVerify Email
Input
tokenstringrequired≥ 32 chars
Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
campaigns 14
POST/api/trpc/campaigns.createCampaignCreate Campaign
Input
namestringrequired≥ 3 chars
typestringrequiredsubjectstringoptionalcontentstringoptionalscheduledbooleanrequireddefault
falsescheduledDateanyoptionaltestModebooleanrequireddefault
falsetestEmailstring · emailoptionaltemplateIdstringoptionalsegmentIdstringoptionalmarketingCampaignIdstringoptionalchannelTypestringoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/campaigns.createCampaignTagCreate Campaign Tag
Input
namestringrequired≥ 1 chars
Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/campaigns.createCampaignWizardCreate Campaign Wizard
Input
channelTypeobjectrequiredchannelTypestringrequired≥ 1 chars
campaignobjectoptionalmarketingCampaignIdstringoptionaldetailsobjectrequirednamestringrequiredtypeIdstringoptionalstatusenumrequired"draft" "scheduled" "active" "completed" "cancelled"startDateanyrequiredendDateanyoptionaldescriptionstringoptionaltemplateobjectrequiredtemplateIdstringoptionalsubjectstringrequiredcontentstringrequiredmjmlstringrequiredpreviewTextstringoptionaldataSchemaobjectoptionalaudienceobjectrequiredsegmentsstring[]requiredfiltersobjectoptionalexcludedSegmentsstring[]optionalscheduleobjectrequiredsendTimeenumrequired"immediate" "scheduled"scheduledDateanyoptionaltimezonestringrequiredthrottlingobjectoptionalenabledbooleanrequiredratenumberoptionalintervalenumoptional"minute" "hour"Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/campaigns.deleteCampaignDelete Campaign
Input
idstringrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/campaigns.duplicateCampaignDuplicate Campaign
Input
idstringrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/campaigns.getCampaignActivityGet Campaign Activity
Input
idstringrequiredpagenumberrequireddefault
0per_pagenumberrequireddefault
10Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/campaigns.getCampaignByIdGet Campaign By Id
Input
idstringrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/campaigns.getCampaignsGet Campaigns
Input
pagenumberrequireddefault
0per_pagenumberrequireddefault
10searchstringrequireddefault
""statusstringoptionalResponse
200 Success. The result is in
result.data.json : objectdataany[]optionaltotalintegeroptionalpageintegeroptionalper_pageintegeroptionaltotalPagesintegeroptionalTry it
GET/api/trpc/campaigns.getCampaignTagsGet Campaign Tags
Input
No input.
Response
200 Success. The result is in
result.data.json : object[]idstringoptionalnamestringoptionaldescriptionanyoptionaltenantIdstringoptionalsiteIdstringoptionalTry it
POST/api/trpc/campaigns.pauseCampaignPause Campaign
Input
idstringrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/campaigns.resumeCampaignResume Campaign
Input
idstringrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/campaigns.sendCampaignSend Campaign
Input
idstringrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/campaigns.simulateActivitySimulate Activity
Input
idstringrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/campaigns.updateCampaignUpdate Campaign
Input
namestringrequired≥ 3 chars
typestringrequiredsubjectstringoptionalcontentstringoptionalscheduledbooleanrequireddefault
falsescheduledDateanyoptionaltestModebooleanrequireddefault
falsetestEmailstring · emailoptionaltemplateIdstringoptionalsegmentIdstringoptionalmarketingCampaignIdstringoptionalchannelTypestringoptionalidstringrequiredstatusenumoptional"draft" "scheduled" "active" "paused" "completed" "error"Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
clients 18
POST/api/trpc/clients.approveProApprove Pro
Input
clientIdstring · uuidrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/clients.createCreate
Input
namestringrequired≥ 1 chars
emailstring · emailoptionalphonestringoptionaladdressstringoptionalzipCodestringoptionalcitystringoptionalcountrystringoptionalsiretstringoptionalcodeNafstringoptionaltypeIdstringoptionalarchivedbooleanrequireddefault
falseisMainRecordbooleanrequireddefault
trueisProfessionalbooleanrequireddefault
falseexternalIdstringoptionalmainRecordIdstringoptionaltiersIdstring | nulloptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/clients.deleteAllClientsDelete All Clients
Input
confirmationIdstringrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/clients.deleteClientDelete Client
Input
idstringrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/clients.deleteClientsDelete Clients
Input
idsstring[]requiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/clients.getClientByIdGet Client By Id
Input
idstringrequiredResponse
200 Success. The result is in
result.data.json : objectidstringoptionalnamestringoptionaladdressanyoptionalzipCodeanyoptionalcityanyoptionalcountryanyoptionalemailstringoptionalphoneanyoptionalsiretanyoptionalcodeNafanyoptionalcustomInputsobjectoptionallastNamestringoptionalfirstNamestringoptionallastUpdatedstringoptionalprestashop_idstringoptionalexternalIdanyoptionalarchivedbooleanoptionalisProfessionalbooleanoptionaltenantIdstringoptionalsiteIdstringoptionalcreatedAtstringoptionalupdatedAtstringoptionalisMainRecordbooleanoptionalmainRecordIdanyoptionaltypeIdanyoptionaltiersIdanyoptionalterritoryIdanyoptionaldataanyoptionaltypeanyoptionalTiersanyoptionalsentInvoicesany[]optionalreceivedInvoicesany[]optionalreceivedOrdersobject[]optionalidstringoptionalinvoiceNumberstringoptionalinvoiceStatusstringoptionaltotalAmountnumberoptionalcreatedAtstringoptionalinvoiceDatestringoptionaldeliveryDatestringoptionalTry it
GET/api/trpc/clients.getClientContactsGet Client Contacts
Input
clientIdstringrequiredpagenumberrequireddefault
1per_pagenumberrequireddefault
10searchstringoptionalsortstringoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/clients.getClientsByTiersGet Clients By Tiers
Input
tiersIdstringrequiredpagenumberrequireddefault
1per_pagenumberrequireddefault
20searchstringoptionalsortstringoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/clients.getClientsGet Clients
Input
pagenumberrequireddefault
1per_pagenumberrequireddefault
20sortstringoptionalsearchstring | nulloptionalcursornumber | nulloptionalfiltersobjectoptionaladvancedFiltersany[]optionaladvancedSortsobject[]optionalfieldstringrequireddirectionenumrequired"asc" "desc"Response
200 Success. The result is in
result.data.json : objectdataobject[]optionalidstringoptionalnamestringoptionalemailstringoptionalphoneanyoptionaladdressanyoptionalzipCodeanyoptionalcityanyoptionalcountryanyoptionalsiretanyoptionalcodeNafanyoptionalarchivedbooleanoptionalcreatedAtstringoptionalupdatedAtstringoptionalisMainRecordbooleanoptionalisProfessionalbooleanoptionalexternalIdanyoptionalmainRecordIdanyoptionaltypeIdanyoptionaltiersIdanyoptionalcustomInputsobjectoptionallastNamestringoptionalfirstNamestringoptionallastUpdatedstringoptionalprestashop_idstringoptionaltypeanyoptionalTiersanyoptionalsentInvoicesany[]optionalreceivedInvoicesany[]optionalreceivedOrdersobject[]optionalidstringoptionalinvoiceNumberstringoptionalinvoiceStatusstringoptionaltotalAmountnumberoptionalcreatedAtstringoptionalinvoiceDatestringoptionaldeliveryDatestringoptionaltotalintegeroptionalpageCountintegeroptionalcolumnsobjectoptionalnameobjectoptionaltypestringoptionallabelstringoptionalrequiredbooleanoptionalsortablebooleanoptionalfilterablebooleanoptionaltypeobjectoptionaltypestringoptionallabelstringoptionalrequiredbooleanoptionalsortablebooleanoptionalfilterablebooleanoptionalrelationTablestringoptionalrelationLabelFieldstringoptionalrelationColorFieldstringoptionalrelationIconFieldstringoptionalemailobjectoptionaltypestringoptionallabelstringoptionalrequiredbooleanoptionalsortablebooleanoptionalfilterablebooleanoptionalphoneobjectoptionaltypestringoptionallabelstringoptionalrequiredbooleanoptionalsortablebooleanoptionalfilterablebooleanoptionaladdressobjectoptionaltypestringoptionallabelstringoptionalrequiredbooleanoptionalsortablebooleanoptionalfilterablebooleanoptionalzipCodeobjectoptionaltypestringoptionallabelstringoptionalrequiredbooleanoptionalsortablebooleanoptionalfilterablebooleanoptionalcityobjectoptionaltypestringoptionallabelstringoptionalrequiredbooleanoptionalsortablebooleanoptionalfilterablebooleanoptionalcountryobjectoptionaltypestringoptionallabelstringoptionalrequiredbooleanoptionalsortablebooleanoptionalfilterablebooleanoptionalsiretobjectoptionaltypestringoptionallabelstringoptionalrequiredbooleanoptionalsortablebooleanoptionalfilterablebooleanoptionalcodeNafobjectoptionaltypestringoptionallabelstringoptionalrequiredbooleanoptionalsortablebooleanoptionalfilterablebooleanoptionalarchivedobjectoptionaltypestringoptionallabelstringoptionalrequiredbooleanoptionalsortablebooleanoptionalfilterablebooleanoptionaloptionsobject[]optionallabelstringoptionalvaluestringoptionalisProfessionalobjectoptionaltypestringoptionallabelstringoptionalrequiredbooleanoptionalsortablebooleanoptionalfilterablebooleanoptionaloptionsobject[]optionallabelstringoptionalvaluestringoptionalisMainRecordobjectoptionaltypestringoptionallabelstringoptionalrequiredbooleanoptionalsortablebooleanoptionalfilterablebooleanoptionaloptionsobject[]optionallabelstringoptionalvaluestringoptionalcreatedAtobjectoptionaltypestringoptionallabelstringoptionalrequiredbooleanoptionalsortablebooleanoptionalfilterablebooleanoptionalupdatedAtobjectoptionaltypestringoptionallabelstringoptionalrequiredbooleanoptionalsortablebooleanoptionalfilterablebooleanoptionalnextCursorintegeroptionalTry it
POST/api/trpc/clients.linkContactLink Contact
Input
clientIdstringrequiredcontactIdstringrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/clients.listPendingProList Pending Pro
Input
pagenumberrequired≥ 1 · default
1perPagenumberrequired1–100 · default
20Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/clients.refuseProRefuse Pro
Input
clientIdstring · uuidrequiredreasonstringrequired3–2000 chars
Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/clients.requestProSignupRequest Pro Signup
Input
companyNamestringrequired≥ 1 chars
siretstringrequiredcodeNafstring | nulloptionaladdressstringrequired≥ 1 chars
zipCodestringrequired≥ 1 chars
citystringrequired≥ 1 chars
firstNamestringrequired≥ 1 chars
lastNamestringrequired≥ 1 chars
rolestring | nulloptionalphonestringrequired≥ 1 chars
emailstring · emailrequiredpasswordstringrequired≥ 8 chars
filierestringrequired≥ 1 chars
volumeEstimatestring | nulloptionalmessagestring | nulloptionalnewsletterbooleanrequireddefault
falseResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/clients.searchContactsToLinkSearch Contacts To Link
Input
searchstringoptionalpagenumberrequireddefault
1per_pagenumberrequireddefault
10Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/clients.syncClientsSync Clients
Input
offsetnumberrequiredlimitnumberrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/clients.unlinkContactUnlink Contact
Input
clientIdstringrequiredcontactIdstringrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/clients.unlinkTiersUnlink Tiers
Input
idstringrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/clients.updateClientUpdate Client
Input
idstringrequirednamestringoptional≥ 1 chars
emailstring · emailoptionalphonestringoptionaladdressstringoptionalzipCodestringoptionalcitystringoptionalcountrystringoptionalsiretstringoptionalcodeNafstringoptionaltypeIdstringoptionalarchivedbooleanoptionalisMainRecordbooleanoptionalisProfessionalbooleanoptionalexternalIdstringoptionalmainRecordIdstringoptionaltiersIdstring | nulloptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
coupons 6
POST/api/trpc/coupons.createCreate
Input
codestringrequired1–64 chars
typeenumrequired"PERCENT" "FLAT"valueintegerrequired0–9007199254740991
appliesToPlanIdsstring · uuid[]requireddefault
[]appliesToCountryenum | nulloptionalappliesToDurationYearsinteger | nulloptionalvalidFromany | nulloptionalvalidToany | nulloptionalmaxRedemptionsinteger | nulloptionaldescriptionstring | nulloptionalactivebooleanrequireddefault
trueResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/coupons.deleteDelete
Input
idstring · uuidrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
GET/api/trpc/coupons.getGet
Input
idstring · uuidrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
GET/api/trpc/coupons.listList
Input
activeOnlybooleanrequireddefault
falseResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/coupons.updateUpdate
Input
codestringoptional1–64 chars
typeenumoptional"PERCENT" "FLAT"valueintegeroptional0–9007199254740991
appliesToPlanIdsstring · uuid[]optionalappliesToCountryenum | nulloptionalappliesToDurationYearsinteger | nulloptionalvalidFromany | nulloptionalvalidToany | nulloptionalmaxRedemptionsinteger | nulloptionaldescriptionstring | nulloptionalactivebooleanoptionalidstring · uuidrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
GET/api/trpc/coupons.validateValidate
Input
codestringrequired1–64 chars
countryenumrequired"FR" "WORLD" · default "FR"itemsobject[]requireddefault
[]planIdstringrequiredkindenumrequired"subscription" "magazine" · default "magazine"durationYearsintegeroptional1–2
lineTotalnumberrequired≥ 0
Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
helpdeskKb 10
POST/api/trpc/helpdeskKb.createArticleCreate Article
Input
titlestringrequired≥ 1 chars
slugstringoptionalexcerptstringoptionalbodystringoptionalstatusstringoptionalvisibilitystringoptionalcategoryIdstring | nulloptionaltagsstring[]optionalseoTitlestringoptionalseoDescriptionstringoptionalordernumberoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/helpdeskKb.createCategoryCreate Category
Input
namestringrequired≥ 1 chars
slugstringoptionaldescriptionstringoptionaliconstringoptionalparentIdstring | nulloptionalordernumberoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/helpdeskKb.deleteArticleDelete Article
Input
idstringrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/helpdeskKb.deleteCategoryDelete Category
Input
idstringrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/helpdeskKb.getArticleByIdGet Article By Id
Input
idstringrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/helpdeskKb.getArticlesGet Articles
Input
searchstringoptionalstatusstringoptionalvisibilitystringoptionalcategoryIdstringoptionalincludeArchivedbooleanrequireddefault
falseResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/helpdeskKb.getCategoriesGet Categories
Input
No input.
Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/helpdeskKb.getCategoryByIdGet Category By Id
Input
idstringrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/helpdeskKb.updateArticleUpdate Article
Input
titlestringoptional≥ 1 chars
slugstringoptionalexcerptstringoptionalbodystringoptionalstatusstringoptionalvisibilitystringoptionalcategoryIdstring | nulloptionaltagsstring[]optionalseoTitlestringoptionalseoDescriptionstringoptionalordernumberoptionalidstringrequiredarchivedbooleanoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/helpdeskKb.updateCategoryUpdate Category
Input
namestringoptional≥ 1 chars
slugstringoptionaldescriptionstringoptionaliconstringoptionalparentIdstring | nulloptionalordernumberoptionalidstringrequiredarchivedbooleanoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
invoices 26
POST/api/trpc/invoices.convertQuoteConvert Quote
Input
idstringrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/invoices.createCreditNoteCreate Credit Note
Input
idstringrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/invoices.createDraftCreate Draft
Input
receiverIdstringrequiredinvoiceTypeenumoptional"INVOICE" "QUOTE" "PURCHASE_ORDER"invoiceDatestringoptionaldueDatestringoptionalnotesstringoptionalcurrencystringoptionaltemplateIdintegeroptional1–5
itemsobject[]requirednamestringrequiredquantitynumberrequiredunitPricenumberrequiredtaxRatenumberrequireddefault
20productIdstringoptionalproductSkustringoptionaldiscountobjectoptionaltypeenumrequired"PERCENT" "FIXED"valuenumberrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/invoices.createInvoiceCreate Invoice
Input
numberstringrequiredclientIdstringrequiredtotalnumberrequireditemsobject[]requireddescriptionstringrequiredquantitynumberrequiredunitPricenumberrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/invoices.createStripeConnectAccountCreate Stripe Connect Account
Input
refreshUrlstring · urirequiredreturnUrlstring · urirequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/invoices.createStripeConnectLinkCreate Stripe Connect Link
Input
refreshUrlstring · urirequiredreturnUrlstring · urirequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/invoices.deleteAllInvoicesDelete All Invoices
Input
confirmationIdstringrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/invoices.deleteInvoiceDelete Invoice
Input
idstringrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/invoices.deleteIssuerProfileDelete Issuer Profile
Input
scopeobjectrequiredlevelenumrequired"tenant" "site" "domain" · default "site"domainIdstringoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/invoices.disconnectStripeDisconnect Stripe
Input
No input.
Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/invoices.getClientsForSelectGet Clients For Select
Input
No input.
Response
200 Success. The result is in
result.data.json : object[]idstringoptionalnamestringoptionalemailstringoptionalTry it
GET/api/trpc/invoices.getCrossTenantOverviewGet Cross Tenant Overview
Input
No input.
Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/invoices.getCrossTenantPaymentStatusGet Cross Tenant Payment Status
Input
No input.
Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/invoices.getDashboardMetricsGet Dashboard Metrics
Input
No input.
Response
200 Success. The result is in
result.data.json : objectmonthlyobject[]optionallabelstringoptionalfactureintegeroptionalencaisseintegeroptionalbyStatusany[]optionalTry it
GET/api/trpc/invoices.getEffectiveIssuerProfileGet Effective Issuer Profile
Input
No input.
Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/invoices.getInvoiceGet Invoice
Input
idstringrequiredResponse
200 Success. The result is in
result.data.json : objectidstringoptionalsenderIdstringoptionalreceiverIdstringoptionalinvoiceLogoanyoptionalinvoiceNumberstringoptionalinvoiceDatestringoptionalinvoiceTypeanyoptionalinvoiceStatusstringoptionaldueDateanyoptionalpurchaseOrderNumberanyoptionalcurrencystringoptionallanguagestringoptionalpaymentInformationobjectoptionaltaxDetailsobjectoptionaldiscountDetailsobjectoptionalshippingDetailsobjectoptionalsubTotalanyoptionaltotalAmountintegeroptionaltotalAmountInWordsstringoptionaladditionalNotesanyoptionalpaymentTermsstringoptionalpaymentMethodanyoptionalsignatureobjectoptionalstartedAtanyoptionalendedAtanyoptionallocationanyoptionalcreatedAtstringoptionalupdatedAtstringoptionalpdfTemplateintegeroptionalpdfFormatanyoptionalcustomInputsanyoptionalfooteranyoptionalsourceanyoptionalemplacementIdanyoptionaltenantIdstringoptionaluserIdanyoptionalsiteIdstringoptionalrecurringInvoiceIdanyoptionaldomainIdanyoptionalissuerProfileIdanyoptionalsequenceKeyanyoptionalissuedAtanyoptionallockedbooleanoptionalitemsany[]optionalreceiverobjectoptionalidstringoptionalnamestringoptionaladdressanyoptionalzipCodeanyoptionalcityanyoptionalcountryanyoptionalemailanyoptionalphoneanyoptionalsiretanyoptionalcodeNafanyoptionalcustomInputsobjectoptionalexternalIdanyoptionalarchivedbooleanoptionalisProfessionalbooleanoptionaltenantIdstringoptionalsiteIdstringoptionalcreatedAtstringoptionalupdatedAtstringoptionalisMainRecordbooleanoptionalmainRecordIdanyoptionaltypeIdanyoptionaltiersIdanyoptionalterritoryIdanyoptionaldataanyoptionalsenderobjectoptionalidstringoptionalnamestringoptionaladdressanyoptionalzipCodeanyoptionalcityanyoptionalcountryanyoptionalemailanyoptionalphoneanyoptionalsiretanyoptionalcodeNafanyoptionalcustomInputsobjectoptionalexternalIdanyoptionalarchivedbooleanoptionalisProfessionalbooleanoptionaltenantIdstringoptionalsiteIdstringoptionalcreatedAtstringoptionalupdatedAtstringoptionalisMainRecordbooleanoptionalmainRecordIdanyoptionaltypeIdanyoptionaltiersIdanyoptionalterritoryIdanyoptionaldataanyoptionalpdfUrlanyoptionalTry it
GET/api/trpc/invoices.getInvoicesGet Invoices
Input
limitnumberrequired1–100 · default
50offsetnumberrequired≥ 0 · default
0statusstringoptionaltypeenumoptional"INVOICE" "QUOTE" "CREDIT_NOTE"Response
200 Success. The result is in
result.data.json : object[]idstringoptionalsenderIdstringoptionalreceiverIdstringoptionalinvoiceLogoanyoptionalinvoiceNumberstringoptionalinvoiceDatestringoptionalinvoiceTypeanyoptionalinvoiceStatusstringoptionaldueDateanyoptionalpurchaseOrderNumberanyoptionalcurrencystringoptionallanguagestringoptionalpaymentInformationobjectoptionaltaxDetailsobjectoptionaldiscountDetailsobjectoptionalshippingDetailsobjectoptionalsubTotalanyoptionaltotalAmountintegeroptionaltotalAmountInWordsstringoptionaladditionalNotesanyoptionalpaymentTermsstringoptionalpaymentMethodanyoptionalsignatureobjectoptionalstartedAtanyoptionalendedAtanyoptionallocationanyoptionalcreatedAtstringoptionalupdatedAtstringoptionalpdfTemplateintegeroptionalpdfFormatanyoptionalcustomInputsanyoptionalfooteranyoptionalsourceanyoptionalemplacementIdanyoptionaltenantIdstringoptionaluserIdanyoptionalsiteIdstringoptionalrecurringInvoiceIdanyoptionaldomainIdanyoptionalissuerProfileIdanyoptionalsequenceKeyanyoptionalissuedAtanyoptionallockedbooleanoptionalreceiverobjectoptionalidstringoptionalnamestringoptionaladdressanyoptionalzipCodeanyoptionalcityanyoptionalcountryanyoptionalemailanyoptionalphoneanyoptionalsiretanyoptionalcodeNafanyoptionalcustomInputsobjectoptionalexternalIdanyoptionalarchivedbooleanoptionalisProfessionalbooleanoptionaltenantIdstringoptionalsiteIdstringoptionalcreatedAtstringoptionalupdatedAtstringoptionalisMainRecordbooleanoptionalmainRecordIdanyoptionaltypeIdanyoptionaltiersIdanyoptionalterritoryIdanyoptionaldataanyoptionalpdfUrlanyoptionalTry it
GET/api/trpc/invoices.getIssuerProfileGet Issuer Profile
Input
scopeobjectoptionallevelenumrequired"tenant" "site" "domain" · default "site"domainIdstringoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/invoices.getPaymentSettingsGet Payment Settings
Input
No input.
Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/invoices.getPublicInvoiceGet Public Invoice
Input
tokenstringrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/invoices.listIssuerScopesList Issuer Scopes
Input
No input.
Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/invoices.saveIssuerProfileSave Issuer Profile
Input
scopeobjectoptionallevelenumrequired"tenant" "site" "domain" · default "site"domainIdstringoptionallegalNamestringrequired≥ 1 chars
emailstringoptionalphonestringoptionalsiretstringoptionalsirenstringoptionalvatNumberstringoptionalibanstringoptionalbicstringoptionallogoUrlstringoptionalcurrencystringoptionaleditorLayoutenumoptional"form" "split" "document" "wizard" "catalog"pdfTemplateintegeroptional1–4
invoicePrefixstringoptionalquotePrefixstringoptionalcreditNotePrefixstringoptionallegalMentionsstringoptionaladdressobjectoptionalstreetstringoptionalcitystringoptionalpostalCodestringoptionalcountrystringoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/invoices.savePaymentKeysSave Payment Keys
Input
secretKeystringoptionalpublishableKeystringoptionalenabledbooleanoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/invoices.searchProductsSearch Products
Input
qstringrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/invoices.updateDraftUpdate Draft
Input
idstringrequiredreceiverIdstringoptionalinvoiceTypeenumoptional"INVOICE" "QUOTE" "PURCHASE_ORDER"invoiceDatestringoptionaldueDatestringoptionalnotesstringoptionalcurrencystringoptionaltemplateIdintegeroptional1–5
itemsobject[]requirednamestringrequiredquantitynumberrequiredunitPricenumberrequiredtaxRatenumberrequireddefault
20productIdstringoptionalproductSkustringoptionaldiscountobjectoptionaltypeenumrequired"PERCENT" "FIXED"valuenumberrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/invoices.updateInvoiceStatusUpdate Invoice Status
Input
idstringrequiredstatusstringrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
newsletter 18
POST/api/trpc/newsletter.addSubscriberAdd Subscriber
Input
emailstringrequiredfirstNamestringoptionallastNamestringoptionaltagsstring[]optionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/newsletter.bulkDeleteBulk Delete
Input
idsstring · uuid[]requiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/newsletter.bulkUpdateStatusBulk Update Status
Input
idsstring · uuid[]requiredstatusenumrequired"subscribed" "unsubscribed"Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/newsletter.exportSubscribersExport Subscribers
Input
formatenumrequired"csv" "json" · default "csv"subscribedOnlybooleanrequireddefault
trueResponse
200 Success. The result is in
result.data.json : objectdatastringoptionalformatstringoptionalTry it
GET/api/trpc/newsletter.getAvailableTemplatesGet Available Templates
Input
typeenumrequired"welcome" "confirmation" "unsubscribe" "all" · default "all"Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/newsletter.getGrowthDataGet Growth Data
Input
daysnumberrequired7–365 · default
90Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/newsletter.getSettingsGet Settings
Input
No input.
Response
200 Success. The result is in
result.data.json : objectdoubleOptInbooleanoptionalconfirmationEmailTemplateIdanyoptionalconfirmationTokenExpiryintegeroptionalwelcomeEmailEnabledbooleanoptionalwelcomeEmailTemplateIdanyoptionalwelcomeEmailDelayintegeroptionalunsubscribeConfirmationEnabledbooleanoptionalunsubscribeConfirmationTemplateIdanyoptionaladminNotificationEnabledbooleanoptionaladminNotificationEmailstringoptionaladminDigestEnabledbooleanoptionaladminDigestFrequencystringoptionaldefaultFromNamestringoptionaldefaultFromEmailstringoptionaldefaultReplyTostringoptionalautoArchiveEnabledbooleanoptionalarchiveVisibilitystringoptionalbrandColorstringoptionalheaderLogoUrlstringoptionalfooterTextstringoptionalTry it
GET/api/trpc/newsletter.getStatsGet Stats
Input
No input.
Response
200 Success. The result is in
result.data.json : objecttotalintegeroptionalsubscribedintegeroptionalunsubscribedintegeroptionalthisMonthintegeroptionallastMonthintegeroptionalgrowthPercentintegeroptionalTry it
GET/api/trpc/newsletter.getSubscriberGet Subscriber
Input
idstringrequiredResponse
200 Success. The result is in
result.data.json : objectidstringoptionalfirstNameanyoptionallastNameanyoptionalnamestringoptionalemailstringoptionalphoneanyoptionalmarketingOptInbooleanoptionalemailOptInbooleanoptionalsmsOptInbooleanoptionalsegmentanyoptionalsourceanyoptionalcreatedAtstringoptionallastActivityanyoptionalTry it
GET/api/trpc/newsletter.getSubscriptionStatusGet Subscription Status
Input
emailstringrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/newsletter.importSubscribersImport Subscribers
Input
subscribersobject[]requiredemailstring · emailrequiredfirstNamestringoptionallastNamestringoptionalphonestringoptionalduplicateHandlingenumrequired"update" "skip" · default "update"Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/newsletter.listSubscribersList Subscribers
Input
pagenumberrequireddefault
0limitnumberrequireddefault
25searchstringoptionalsubscribedbooleanoptionalsortByenumrequired"createdAt" "email" "name" · default "createdAt"sortOrderenumrequired"asc" "desc" · default "desc"Response
200 Success. The result is in
result.data.json : objectitemsobject[]optionalidstringoptionalfirstNameanyoptionallastNameanyoptionalnamestringoptionalemailstringoptionalmarketingOptInbooleanoptionalemailOptInbooleanoptionalsmsOptInbooleanoptionalsegmentanyoptionalsourceanyoptionalsubscribedAtstringoptionallastActivityanyoptionaltotalintegeroptionalpageintegeroptionallimitintegeroptionalpagesintegeroptionalTry it
POST/api/trpc/newsletter.subscribeSubscribe
Input
emailstringrequiredfirstNamestringoptionallastNamestringoptionaltenantIdstringoptionalsiteIdstringoptionalhoneypotstringoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/newsletter.testConfirmationEmailTest Confirmation Email
Input
emailstring · emailrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/newsletter.testWelcomeEmailTest Welcome Email
Input
emailstring · emailrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/newsletter.unsubscribeUnsubscribe
Input
emailstringrequiredtokenstringoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/newsletter.updateSettingsUpdate Settings
Input
doubleOptInbooleanoptionaldefault
falseconfirmationEmailTemplateIdstring · uuid | nulloptionalconfirmationTokenExpirynumberoptional1–168 · default
24welcomeEmailEnabledbooleanoptionaldefault
truewelcomeEmailTemplateIdstring · uuid | nulloptionalwelcomeEmailDelaynumberoptional0–10080 · default
0unsubscribeConfirmationEnabledbooleanoptionaldefault
trueunsubscribeConfirmationTemplateIdstring · uuid | nulloptionaladminNotificationEnabledbooleanoptionaldefault
falseadminNotificationEmailstring · email | ""optionaladminDigestEnabledbooleanoptionaldefault
falseadminDigestFrequencyenumoptional"daily" "weekly" · default "daily"defaultFromNamestringoptionaldefaultFromEmailstring · email | ""optionaldefaultReplyTostring · email | ""optionalautoArchiveEnabledbooleanoptionaldefault
falsearchiveVisibilityenumoptional"public" "private" · default "private"brandColorstringoptionaldefault
"#146BFF"headerLogoUrlstring · uri | ""optionalfooterTextstringoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/newsletter.updateSubscriberUpdate Subscriber
Input
idstring · uuidrequiredmarketingOptInbooleanoptionalemailOptInbooleanoptionalsmsOptInbooleanoptionalfirstNamestringoptionallastNamestringoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
orders 48
POST/api/trpc/orders.createOrderItemCreate Order Item
Input
orderIdstring · uuidrequirednamestringrequired≥ 1 chars
descriptionstring | nulloptionalquantityintegerrequired> 0–9007199254740991
unitPricenumberrequired≥ 0
productIdstring · uuid | nulloptionalvendorIdstring · uuid | nulloptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/orders.createOrderCreate Order
Input
invoiceNumberanyrequiredinvoiceDateanyrequireddeliveryDateany | nulloptionalinvoiceStatusenumrequired"DRAFT" "SENT" "PAID" "OVERDUE" "CANCELED" · default "DRAFT"receiverIdstringoptionalsenderIdstringoptionalclientIdstringoptionalcurrencystringrequireddefault
"EUR"totalAmountnumberrequireddefault
0additionalNotesstringoptionalitemsobject[]requireddefault
[]productIdstringoptionalnamestringrequireddescriptionstring | nulloptionalquantityintegerrequired> 0–9007199254740991
unitPricenumberrequired≥ 0
recalculateVendorsbooleanoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/orders.deleteOrderItemDelete Order Item
Input
idstring · uuidrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/orders.deleteOrderDelete Order
Input
idstringrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/orders.deleteOrdersDelete Orders
Input
idsstring[]requiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/orders.exportOrdersExport Orders
Input
formatenumrequired"csv" "xlsx" "json"filtersobjectoptionalsearchstringoptionalsortstringoptionaladvancedFiltersany[]optionaladvancedSortsobject[]optionalfieldstringrequireddirectionenumrequired"asc" "desc"columnsstring[]optionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/orders.fetchOrdersFetch Orders
Input
No input.
Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/orders.fulfillment.cancelFulfillment.cancel
Input
fulfillmentIdstring · uuidrequiredreasonstringoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/orders.fulfillment.createFulfillment.create
Input
orderIdstring · uuidrequiredmethodenumrequired"SHIPPING" "PICKUP" "DIGITAL" "LOCAL_DELIVERY"itemsobject[]required≥ 1 items
orderItemIdstring · uuidrequiredquantityintegerrequired> 0–9007199254740991
carrierstringoptionaltrackingNumberstringoptionaltrackingUrlstring · urioptionalestimatedDeliveryanyoptionalshippingAddressobjectoptionalfirstNamestringrequired≥ 1 chars
lastNamestringrequired≥ 1 chars
companystringoptionaladdressstringrequired≥ 1 chars
citystringrequired≥ 1 chars
postalCodestringrequired≥ 1 chars
countrystringrequired≥ 1 chars
phonestringoptionalemailstring · emailoptionalinstructionsstringoptionalshipmentIdstring · uuidoptionalnotesstringoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
GET/api/trpc/orders.fulfillment.listByOrderFulfillment.list By Order
Input
orderIdstring · uuidrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
GET/api/trpc/orders.fulfillment.trackFulfillment.track
Input
fulfillmentIdstring · uuidrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/orders.fulfillment.updateStatusFulfillment.update Status
Input
fulfillmentIdstring · uuidrequiredstatusenumrequired"PENDING" "PROCESSING" "READY_TO_SHIP" "SHIPPED" "IN_TRANSIT" "OUT_FOR_DELIVERY" "DELIVERED" "FAILED_DELIVERY" "RETURNED" "CANCELLED"trackingNumberstringoptionaltrackingUrlstring · urioptionalactualDeliveryanyoptionalnotesstringoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
GET/api/trpc/orders.getCheckoutEventsGet Checkout Events
Input
orderIdstring · uuidrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
GET/api/trpc/orders.getInvoicesGet Invoices
Input
pageanyrequiredper_pageanyrequiredsearchstringoptionalsortstringoptionalfiltersobjectoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/orders.getLiveOrdersGet Live Orders
Input
statusesenum[]optionallimitnumberrequireddefault
50sortByenumrequired"invoiceDate" "createdAt" "updatedAt" · default "invoiceDate"sortOrderenumrequired"asc" "desc" · default "asc"Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/orders.getMyOrdersGet My Orders
Input
limitnumberrequired1–200 · default
20cursorstringoptionalstatusstringoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/orders.getOrderByIdGet Order By Id
Input
idstringrequiredResponse
200 Success. The result is in
result.data.json : objectidstringoptionalcreatedAtstringoptionalupdatedAtstringoptionalinvoiceNumberstringoptionalreferenceanyoptionalinvoiceDatestringoptionaldeliveryDatestringoptionalorderTypestringoptionalinvoiceStatusstringoptionaltotalAmountnumberoptionalcurrencystringoptionalsourceanyoptionalpaymentIntentIdanyoptionalstripeSessionIdanyoptionalstripeInvoiceIdanyoptionalplenigoOrderIdanyoptionalexpiresAtanyoptionalpaymentMethodanyoptionalsenderIdstringoptionalreceiverIdstringoptionalclientIdstringoptionalcustomInputsobjectoptionalnotestringoptionalvalidstringoptionalstatusstringoptionalcustomerobjectoptionalemailstringoptionallastNamestringoptionalfirstNamestringoptionalreferencestringoptionalpickup_slotanyoptionaldelivery_datestringoptionaldelivery_slotobjectoptionaldaystringoptionalhourstringoptionalcauseanyoptionalmanualbooleanoptionalhour_endstringoptionalremindedbooleanoptionalmanual_commentanyoptionalstore_informedbooleanoptionalprestashop_idstringoptionalinvoice_numberstringoptionalpayment_methodstringoptionalinvoice_addressobjectoptionalcitystringoptionaladdressstringoptionalcountrystringoptionaladdress2stringoptionallastNamestringoptionalpostcodestringoptionalfirstNamestringoptionaldelivery_addressobjectoptionalcitystringoptionaladdressstringoptionalcountrystringoptionaladdress2stringoptionallastNamestringoptionalpostcodestringoptionalfirstNamestringoptionaldeliveryDataHistoryobjectoptionalentriesobject[]optionalreasonstringoptionalsourcestringoptionalnewDatestringoptionaloldDateanyoptionalmetadataobjectoptionaltimestampstringoptionalcreatedAtstringoptionallastUpdatedstringoptionaltenantIdstringoptionalsiteIdstringoptionalappliedVoucherIdanyoptionalsubscriptionIdanyoptionalisRenewalOrderbooleanoptionalrequiresValidationbooleanoptionalvalidatedAtanyoptionalvalidatedByanyoptionalprocessedAtanyoptionalprocessedByanyoptionalitemsobject[]optionalidstringoptionalcreatedAtstringoptionalupdatedAtstringoptionalnamestringoptionaldescriptionstringoptionalquantityintegeroptionalunitPricenumberoptionaldataobjectoptionalgenericMappingobjectoptionalmappedQuantityintegeroptionalconversionFactornumberoptionalgenericProductIdstringoptionaloriginalQuantityintegeroptionalexternalProductIdstringoptionalexternalOrderIdstringoptionalexternalProductIdstringoptionalexternalVendorIdanyoptionalexternalItemIdstringoptionalorderIdstringoptionalproductIdstringoptionalproductVariationIdanyoptionalvendorIdstringoptionalvoucherDiscountAmountanyoptionalsiteIdstringoptionalproductobjectoptionalidstringoptionalnamestringoptionalreferencestringoptionalskuanyoptionalpriceintegeroptionalsalePriceanyoptionalmainImageIdanyoptional_countobjectoptionalbundleComponentsintegeroptionalvendorobjectoptionalidstringoptionalnamestringoptionalemailstringoptionalclientobjectoptionalidstringoptionalnamestringoptionalemailstringoptionalphonestringoptionaladdressstringoptionalzipCodestringoptionalcitystringoptionalcountrystringoptionalsiretanyoptionalisProfessionalbooleanoptionalsenderobjectoptionalidstringoptionalnameanyoptionalemailstringoptionalreceiverobjectoptionalidstringoptionalnamestringoptionalemailstringoptionalvendorsany[]optionalTry it
GET/api/trpc/orders.getOrderItemsGet Order Items
Input
orderIdstringrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/orders.getOrdersByIdsForProductsGet Orders By Ids For Products
Input
idsstring[]required1–200 items
productIdsstring · uuid[]optionalincludeItemsbooleanoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/orders.getOrdersByIdsGet Orders By Ids
Input
idsstring[]required1–50 items
productIdstring · uuidoptionalincludeItemsbooleanoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/orders.getOrdersByProductGet Orders By Product
Input
productIdstring · uuidrequiredpageanyrequiredper_pageanyrequiredsearchstring | nulloptionalstatusenum | nulloptionalsortstring | nulloptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
GET/api/trpc/orders.getOrdersByVendorGet Orders By Vendor
Input
vendorIdstring · uuidrequiredpagenumberrequireddefault
0per_pagenumberrequireddefault
50searchstringoptionalstatusenumoptional"DRAFT" "SENT" "PAID" "OVERDUE" "CANCELED"statusesenum[]optionaldeliveryDateFromstringoptionaldeliveryDateTostringoptionalsortstringoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
GET/api/trpc/orders.getOrdersGet Orders
Input
pageanyrequiredper_pageanyrequiredsearchstring | nulloptionalsortstring | nulloptionalfiltersobjectrequireddefault
{}advancedFiltersany[]requireddefault
[]advancedSortsobject[]requireddefault
[]fieldstringrequireddirectionenumrequired"asc" "desc"fieldsenum | string[]optionaldefault
"detailed"paymentLinkFilterenumoptional"all" "exclude" "only" · default "all"offlinePaymentFilterenumoptional"all" "only" · default "all"Response
200 Success. The result is in
result.data.json : objectdataobject[]optionalidstringoptionalinvoiceNumberstringoptionalinvoiceDatestringoptionalinvoiceStatusstringoptionaltotalAmountnumberoptionalcurrencystringoptionalcreatedAtstringoptionalupdatedAtstringoptionalpaymentMethodanyoptionalexpiresAtanyoptionaldeliveryDatestringoptionalcustomInputsobjectoptionalnotestringoptionalvalidstringoptionalstatusstringoptionalcustomerobjectoptionalemailstringoptionallastNamestringoptionalfirstNamestringoptionalreferencestringoptionalpickup_slotanyoptionaldelivery_datestringoptionaldelivery_slotobjectoptionaldaystringoptionalhourstringoptionalcauseanyoptionalmanualbooleanoptionalhour_endstringoptionalremindedbooleanoptionalmanual_commentanyoptionalstore_informedbooleanoptionalprestashop_idstringoptionalinvoice_numberstringoptionalpayment_methodstringoptionalinvoice_addressobjectoptionalcitystringoptionaladdressstringoptionalcountrystringoptionaladdress2stringoptionallastNamestringoptionalpostcodestringoptionalfirstNamestringoptionaldelivery_addressobjectoptionalcitystringoptionaladdressstringoptionalcountrystringoptionaladdress2stringoptionallastNamestringoptionalpostcodestringoptionalfirstNamestringoptionaldeliveryDataHistoryobjectoptionalentriesobject[]optionalcreatedAtstringoptionallastUpdatedstringoptionalsourceanyoptionalreceiverobjectoptionalidstringoptionalnamestringoptionalemailstringoptionalsenderobjectoptionalidstringoptionalnameanyoptionalemailstringoptionalclientobjectoptionalidstringoptionalnamestringoptionalemailstringoptionalvendorsany[]optionalitemsobject[]optionalidstringoptionalnamestringoptionaldescriptionstringoptionalquantityintegeroptionalunitPricenumberoptionalproductobjectoptionalidstringoptionalnamestringoptionalreferencestringoptionalskuanyoptionalpriceintegeroptionalsalePriceanyoptionalmainImageIdanyoptionaltotalintegeroptionalpageintegeroptionalpageSizeintegeroptionalpageCountintegeroptionalhasNextPagebooleanoptionalhasPrevPagebooleanoptionalTry it
GET/api/trpc/orders.getOrderSubscriptionContextGet Order Subscription Context
Input
orderIdstringrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/orders.getOrderTimersGet Order Timers
Input
orderIdsstring[]optionalactiveOnlybooleanrequireddefault
trueResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/orders.getProductsByOrderGet Products By Order
Input
orderIdstring · uuidrequiredpageanyrequiredper_pageanyrequiredsearchstring | nulloptionalsortstring | nulloptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
GET/api/trpc/orders.getRelatedSupplierOrdersGet Related Supplier Orders
Input
orderIdstring · uuidrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
GET/api/trpc/orders.getUnfulfilledOrdersGet Unfulfilled Orders
Input
searchstringoptionallimitnumberoptionaldefault
50Response
200 Success. The result is in
result.data.json : objectordersobject[]optionalidstringoptionalnumberstringoptionalstatusstringoptionalcustomerNamestringoptionalcustomerobjectoptionalidstringoptionalnamestringoptionalemailstringoptionalcreatedAtstringoptionalitemsobject[]optionalidstringoptionalproductIdstringoptionalproductNamestringoptionalquantityintegeroptionalproductobjectoptionalidstringoptionalnamestringoptionaldefaultVendorIdstringoptionaldefaultVendorobjectoptionalstockintegeroptionalstockAvailabilityanyoptionaltotalintegeroptionalTry it
POST/api/trpc/orders.lifecycle.cancelOrderLifecycle.cancel Order
Input
orderIdstring · uuidrequiredreleaseStockbooleanrequireddefault
trueResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/orders.lifecycle.confirmOrderPaymentLifecycle.confirm Order Payment
Input
orderIdstring · uuidrequiredpaymentIntentIdstringoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/orders.lifecycle.expireDraftOrdersLifecycle.expire Draft Orders
Input
tenantIdstring · uuidoptionalsiteIdstring · uuidoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/orders.lifecycle.getDashboardDataLifecycle.get Dashboard Data
Input
timeRangeenumrequired"today" "7d" "30d" · default "7d"alertsLimitintegerrequired1–50 · default
10Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/orders.lifecycle.getLifecycleAlertsLifecycle.get Lifecycle Alerts
Input
limitintegerrequired1–50 · default
10Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/orders.lifecycle.getLifecycleStatsLifecycle.get Lifecycle Stats
Input
timeRangeenumrequired"today" "7d" "30d" · default "7d"Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/orders.lifecycle.getOrdersExpiringSoonLifecycle.get Orders Expiring Soon
Input
minutesUntilExpiryintegerrequired1–60 · default
15tenantIdstring · uuidoptionalsiteIdstring · uuidoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/orders.markPaidMark Paid
Input
orderIdstring · uuidrequiredpaymentIntentIdstringrequiredpaymentMethodstringoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/orders.markProcessedMark Processed
Input
orderIdstring · uuidrequiredprocessedbooleanrequireddefault
trueResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
GET/api/trpc/orders.refund.calculateRefund.calculate
Input
orderIdstring · uuidrequireditemsobject[]optionalorderItemIdstring · uuidrequiredquantityintegerrequired> 0–9007199254740991
Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/orders.refund.createRefund.create
Input
orderIdstring · uuidrequireditemsobject[]optionalorderItemIdstring · uuidrequiredquantityintegerrequired> 0–9007199254740991
amountnumberoptional≥ > 0
reasonenumrequired"CUSTOMER_REQUEST" "DEFECTIVE_PRODUCT" "WRONG_ITEM" "NOT_AS_DESCRIBED" "DAMAGED_SHIPPING" "DUPLICATE_PAYMENT" "FRAUDULENT_TRANSACTION" "CANCELLED_ORDER" "RETURN_POLICY" "GOODWILL" …reasonDescriptionstringoptionalnotesstringoptionalautoApprovebooleanrequireddefault
falseResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/orders.refund.executeRefund.execute
Input
refundIdstring · uuidrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
GET/api/trpc/orders.refund.listByOrderRefund.list By Order
Input
orderIdstring · uuidrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/orders.refund.processRefund.process
Input
refundIdstring · uuidrequiredapprovebooleanrequirednotesstringoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/orders.syncOrderSync Order
Input
orderIdstring · uuidrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/orders.updateKitchenStatusUpdate Kitchen Status
Input
idstringrequiredkitchenStatusenumrequired"received" "preparing" "ready" "completed"notesstringoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/orders.updateOrderItemUpdate Order Item
Input
object
Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/orders.updateOrderUpdate Order
Input
idstringrequiredinvoiceNumberanyrequiredinvoiceDateanyoptionaldeliveryDateany | nulloptionalinvoiceStatusenumoptional"DRAFT" "SENT" "PAID" "OVERDUE" "CANCELED"receiverIdstring | nulloptionalsenderIdstring | nulloptionalclientIdstring | nulloptionalvendorIdsstring[]optionalcurrencystringoptionaltotalAmountnumberoptionaladditionalNotesstringoptionalitemsobject[]optionalidstringoptionalproductIdstringoptionalnamestringrequireddescriptionstring | nulloptionalquantityintegerrequired> 0–9007199254740991
unitPricenumberrequired≥ 0
recalculateVendorsbooleanoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/orders.updateStatusUpdate Status
Input
idstringrequiredstatusenumrequired"DRAFT" "SENT" "PAID" "OVERDUE" "CANCELED"Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/orders.validateOrderValidate Order
Input
orderIdstring · uuidrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
payments 24
POST/api/trpc/payments.applyMyUpdatedCardApply My Updated Card
Input
printSubscriptionIdstring · uuidrequiredpaymentMethodIdstringrequired≥ 1 chars
Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
GET/api/trpc/payments.checkStripeConfigurationCheck Stripe Configuration
Input
No input.
Response
200 Success. The result is in
result.data.json : objectisConfiguredbooleanoptionalTry it
POST/api/trpc/payments.createEditionCheckoutSessionCreate Edition Checkout Session
Input
editionIdstring · uuidrequiredorderIdstring · uuidoptionalsuccessUrlstringoptionalcancelUrlstringoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/payments.createMagazineCheckoutSessionCreate Magazine Checkout Session
Input
subscriptionPlanIdstring · uuidrequiredsuccessUrlstringoptionalcancelUrlstringoptionalpreviousSubIdstring · uuidoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/payments.createMagazinePurchaseCheckoutSessionCreate Magazine Purchase Checkout Session
Input
itemsobject[]required1–50 items
idstring · uuidrequiredtitlestringrequiredpricenumberoptionalquantityintegerrequired1–100
formatenumoptional"numerique" "papier" "combo"kindenumoptional"subscription" "magazine"durationYears1 | 2optionalisMonthlybooleanoptionalisGiftbooleanoptionalgiftRecipientobjectoptionalfirstNamestringrequired≥ 1 chars
lastNamestringrequired≥ 1 chars
emailstring · emailrequiredaddressstringrequired≥ 1 chars
postalCodestringrequired≥ 1 chars
citystringrequired≥ 1 chars
countrystringrequired≥ 1 chars
messagestringoptionalcountryenumrequired"FR" "WORLD" · default "FR"customerInfoobjectoptionalcivilitystringoptionalfirstNamestringrequiredlastNamestringrequiredemailstring · emailrequiredphonestringrequiredcompanystringoptionaladdressstringrequiredaddress2stringoptionalcitystringrequiredpostalCodestringrequiredcountrystringrequirednotesstringoptionalbillingInfoobjectoptionaladdressstringrequiredaddress2stringoptionalcitystringrequiredpostalCodestringrequiredcountrystringrequireddeliveryOptionstringoptionalpaymentMethodstringoptionaltotalsobjectoptionalsubtotalnumberrequireddeliverynumberrequiredtotalnumberrequiredsuccessUrlstringoptionalcancelUrlstringoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/payments.createMyUpdateCardSetupIntentCreate My Update Card Setup Intent
Input
printSubscriptionIdstring · uuidrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/payments.createOfflineMagazineCheckoutCreate Offline Magazine Checkout
Input
itemsobject[]required≥ 1 items
idstringrequiredtitlestringoptionalpricenumberoptionalquantityintegerrequired1–100 · default
1formatenumoptional"numerique" "papier" "combo"kindenumoptional"subscription" "magazine"durationYears1 | 2optionalisMonthlybooleanoptionalisGiftbooleanoptionalcountryenumrequired"FR" "WORLD" · default "FR"paymentMethodenumrequired"BANK_TRANSFER" "CHEQUE"customerInfoobjectrequiredcivilitystringoptionalfirstNamestringrequired≥ 1 chars
lastNamestringrequired≥ 1 chars
emailstring · emailrequiredphonestringrequired≥ 1 chars
companystringoptionaladdressstringrequired≥ 1 chars
address2stringoptionalcitystringrequired≥ 1 chars
postalCodestringrequired≥ 1 chars
countrystringrequired≥ 1 chars
notesstringoptionalbillingInfoobjectoptionaladdressstringrequiredaddress2stringoptionalcitystringrequiredpostalCodestringrequiredcountrystringrequiredtotalsobjectoptionalsubtotalnumberoptionaldeliverynumberoptionaltotalnumberrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/payments.createOfflineMagazineSubscriptionCheckoutCreate Offline Magazine Subscription Checkout
Input
magazineSubscriptionPlanIdstring · uuidrequiredisMonthlytruerequiredcountryenumrequired"FR" "WORLD" · default "FR"paymentMethodenumrequired"BANK_TRANSFER" "CHEQUE"customerInfoobjectrequiredcivilitystringoptionalfirstNamestringrequired≥ 1 chars
lastNamestringrequired≥ 1 chars
emailstring · emailrequiredphonestringrequired≥ 1 chars
companystringoptionaladdressstringrequired≥ 1 chars
address2stringoptionalcitystringrequired≥ 1 chars
postalCodestringrequired≥ 1 chars
countrystringrequired≥ 1 chars
notesstringoptionalbillingInfoobjectoptionaladdressstringrequiredaddress2stringoptionalcitystringrequiredpostalCodestringrequiredcountrystringrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/payments.createOperatorCardSubscriptionCreate Operator Card Subscription
Input
targetContactIdstring · uuidrequiredmagazineSubscriptionPlanIdstring · uuidrequiredcountryenumrequired"FR" "WORLD" · default "FR"modeenumrequired"RECURRING_MONTHLY" "RECURRING_QUARTERLY" "PER_ISSUE"stripeCustomerIdstringrequired≥ 1 chars
paymentMethodIdstringrequired≥ 1 chars
Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/payments.createOperatorSetupIntentCreate Operator Setup Intent
Input
targetContactIdstring · uuidrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/payments.createPaymentIntentCreate Payment Intent
Input
orderIdstring · uuidrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/payments.createPerIssueCardSetupCheckoutCreate Per Issue Card Setup Checkout
Input
magazineSubscriptionPlanIdstring · uuidrequiredcountryenumrequired"FR" "WORLD" · default "FR"customerEmailstring · emailrequiredcustomerFirstNamestringrequired≥ 1 chars
customerLastNamestringrequired≥ 1 chars
successUrlstring · urirequiredcancelUrlstring · urirequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/payments.createRecurringMagazineSubscriptionCheckoutCreate Recurring Magazine Subscription Checkout
Input
magazineSubscriptionPlanIdstring · uuidrequiredcountryenumrequired"FR" "WORLD" · default "FR"interval"month"requireddefault
"month"intervalCount1 | 3requireddefault
1successUrlstring · urirequiredcancelUrlstring · urirequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/payments.createRecurringMagazineSubscriptionLinkForCustomerCreate Recurring Magazine Subscription Link For Customer
Input
magazineSubscriptionPlanIdstring · uuidrequiredtargetContactIdstring · uuidrequiredcountryenumrequired"FR" "WORLD" · default "FR"interval"month"requireddefault
"month"intervalCount1 | 3requireddefault
1successUrlstring · urirequiredcancelUrlstring · urirequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/payments.createVisitCheckoutSessionCreate Visit Checkout Session
Input
reservationIdstring · uuidrequiredsuccessUrlstringoptionalcancelUrlstringoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
GET/api/trpc/payments.getCheckoutFunnelGet Checkout Funnel
Input
fromstringoptionaltostringoptionalResponse
200 Success. The result is in
result.data.json : objectwindowobjectoptionalfromstringoptionaltostringoptionalfunnelobjectoptionalreachedCheckoutintegeroptionalpayClickedintegeroptionalsessionCreatedintegeroptionalcompletedintegeroptionalprocessingintegeroptionalmintedEventsintegeroptionalexpiredintegeroptionalabandonedFrontendintegeroptionalerrorsintegeroptionalrevenueobjectoptionalpaidCountintegeroptionalpaidAmountintegeroptionalcurrencystringoptionalpendingobjectoptionalinflightintegeroptionalabandonedintegeroptionaleventsByKindany[]optionalTry it
GET/api/trpc/payments.getMagazineCartPricingGet Magazine Cart Pricing
Input
itemsobject[]required1–100 items
idstring · uuidrequiredformatenumoptional"numerique" "papier" "combo"Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
GET/api/trpc/payments.getPaymentMethodsGet Payment Methods
Input
No input.
Response
200 Success. The result is in
result.data.json : object[]idstringoptionalnamestringoptionaltypestringoptionalisActivebooleanoptionalTry it
GET/api/trpc/payments.getPaymentStatsGet Payment Stats
Input
dateFromanyoptionaldateToanyoptionalResponse
200 Success. The result is in
result.data.json : objecttotalTransactionsintegeroptionaltotalAmountnumberoptionalcompletedTransactionsintegeroptionalfailedTransactionsintegeroptionalpendingTransactionsintegeroptionalprocessingTransactionsintegeroptionalcancelledTransactionsintegeroptionaltotalProcessingFeesnumberoptionalaverageTransactionAmountnumberoptionalTry it
GET/api/trpc/payments.getStripeConfigurationGet Stripe Configuration
Input
No input.
Response
200 Success. The result is in
result.data.json : objectsecretKeyanyoptionalpublishableKeyanyoptionalisConfiguredbooleanoptionalTry it
GET/api/trpc/payments.getTransactionByIdGet Transaction By Id
Input
idstringrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/payments.getTransactionsGet Transactions
Input
pageintegerrequired1–9007199254740991 · default
1per_pageintegerrequired1–100 · default
20dateFromanyoptionaldateToanyoptionalstatusenumoptional"PENDING" "PROCESSING" "COMPLETED" "FAILED" "CANCELLED"paymentMethodstringoptionalorderIdstring · uuidoptionalcustomerIdstring · uuidoptionalResponse
200 Success. The result is in
result.data.json : objecttransactionsany[]optionaltotalintegeroptionalpageintegeroptionalper_pageintegeroptionaltotalPagesintegeroptionalTry it
GET/api/trpc/payments.listAbandonedCheckoutsList Abandoned Checkouts
Input
stateenumrequired"abandoned" "inflight" "all" · default "abandoned"limitnumberrequired1–200 · default
50Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/payments.updateStripeConfigurationUpdate Stripe Configuration
Input
secretKeystringrequired≥ 1 chars
publishableKeystringrequired≥ 1 chars
Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
products 27
POST/api/trpc/products.assignSubCategoryToProductAssign Sub Category To Product
Input
productIdstring · uuidrequiredsubCategoryIdstring · uuidrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/products.bulkUpdateBulk Update
Input
updatesobject[]requiredidstring · uuidrequirednamestringoptional≥ 1 chars
descriptionstringoptionalreferencestringoptionalmanufacturerstringoptionalactivebooleanoptionalpricenumberoptional≥ 0
proPricenumber | nulloptionaltaxRatenumberoptional0–100
isBuyablebooleanoptionalpackagingQuantitynumberoptional≥ > 0
packagingUnitstringoptionalsaleDetailstringoptionalsaleQuantitynumberoptional≥ > 0
saleUnitstringoptionalsaleTypestringoptionalstockintegeroptional0–9007199254740991
defaultVendorIdstringoptionalpackagingTypeIdstringoptionaldataPatchobjectoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/products.byPackagingTypeBy Packaging Type
Input
packagingTypeIdstringrequiredpagenumberrequireddefault
0limitnumberrequireddefault
50Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/products.clearProductsCacheClear Products Cache
Input
No input.
Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/products.createCreate
Input
namestringrequired≥ 2 chars
descriptionstringoptionalpricenumberrequired≥ 0
proPricenumber | nulloptionalreferencestringoptionalmanufacturerstringoptionaltaxRatenumberrequired0–100 · default
20defaultVendorIdstringoptionalpackagingTypeIdstringoptionalpackagingQuantitynumberoptional≥ > 0
packagingUnitstringoptionalsaleDetailstringoptionalsaleQuantitynumberoptional≥ > 0
saleUnitstringoptionalsaleTypestringoptionaldefaultTemplateIdstringoptionalisBuyablebooleanrequireddefault
trueactivebooleanrequireddefault
truemainImageIdstring | nulloptionalimagesstring[]requireddefault
[]productTypeenumoptional"SIMPLE" "VARIABLE" "COMPOSITE" "FORMULE" "MENU" · default "SIMPLE"manageStockbooleanoptionaldefault
falsestockintegeroptional0–9007199254740991
lowStockThresholdintegeroptional0–9007199254740991
soldIndividuallybooleanoptionaldefault
falseweightUnitstringoptionalrequiresLotNumberbooleanoptionaldefault
falseshowOrderDetailsbooleanoptionaldefault
falseisPerishablebooleanoptionaldefault
falseperishabilityDaysintegeroptional1–365
deliveryDaysintegeroptional1–30
specificOveragePercentintegeroptional0–100
weightnumberoptional≥ 0
lengthnumberoptional≥ > 0
widthnumberoptional≥ > 0
heightnumberoptional≥ > 0
purchaseNotestringoptionalmenuOrderintegeroptional-9007199254740991–9007199254740991
isGenericbooleanoptionaldefault
falseResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/products.createWithAllNeedsCreate With All Needs
Input
No input.
Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/products.deleteAllProductsDelete All Products
Input
confirmationIdstringrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/products.deleteGenericLinkDelete Generic Link
Input
idstring · uuidrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/products.deleteProductDelete Product
Input
idstringrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/products.getByIdGet By Id
Input
idstringrequiredResponse
200 Success. The result is in
result.data.json : objectidstringoptionalreferencestringoptionalplenigoOfferIdanyoptionalplenigoAccessRightUniqueIdanyoptionalnamestringoptionaldescriptionstringoptionalpricenumberoptionalsalePriceanyoptionalproPriceanyoptionalpurchasePricenumberoptionalstockintegeroptionalstockLedgerintegeroptionalisBuyablebooleanoptionalskustringoptionalisGenericbooleanoptionalmagazineEditionIdanyoptionalsiteIdstringoptionalproductTypestringoptionalmanageStockbooleanoptionallowStockThresholdanyoptionalsoldIndividuallybooleanoptionalweightanyoptionallengthanyoptionalwidthanyoptionalheightanyoptionalpurchaseNoteanyoptionalmenuOrderanyoptionaldataobjectoptionallastSyncstringoptionalprestashop_idstringoptionalprestashop_dataobjectoptionalmpnstringoptionalupcstringoptionalisbnstringoptionalnamestringoptionalratenumberoptionaldepthintegeroptionalean13stringoptionalpricenumberoptionalunitystringoptionalwidthintegeroptionalactivestringoptionalheightintegeroptionalweightintegeroptionaldate_addstringoptionaldate_updstringoptionalquantityintegeroptionalprice_ttcnumberoptionalreferencestringoptionalid_productstringoptionaldescriptionstringoptionalid_supplierstringoptionallink_rewritestringoptionalsupplier_namestringoptionalid_manufacturerstringoptionalwholesale_pricenumberoptionalbundle_componentsany[]optionaldescription_shortstringoptionallinked_categoriesobject[]optionalnamestringoptionalslugstringoptionalpositionintegeroptionalid_categoryintegeroptionalmanufacturer_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[]optionalidstringoptionalproductIdstringoptionalsubCategoryIdstringoptionalassignedAtstringoptionalassignedBystringoptionaltenantIdstringoptionalsiteIdstringoptionalsubCategoryobjectoptionalidstringoptionalnamestringoptionalslugstringoptionaldescriptionstringoptionalimageIdanyoptionalorderanyoptionalexternalIdstringoptionaldataobjectoptionalprestashop_dataobjectoptionalparentCategoryIdstringoptionalmainCategoryIdstringoptionalcreatedAtstringoptionalupdatedAtstringoptionaltenantIdstringoptionalsiteIdstringoptionaltagsany[]optionalassignedAttributesany[]optionalassignedOptionListsany[]optionalvariationsany[]optionalvariantsany[]optionalupsellsany[]optionalcrossSellsany[]optionalbundleComponentsany[]optionalgenericLinksany[]optionalparentGenericLinksany[]optionaleffectivePricenumberoptionalpriceLabelstringoptionalprestashopActivebooleanoptionalisbnanyoptionalean13anyoptionalupcanyoptionalmpnanyoptionalppomanyoptionalppomNormalizedanyoptionalTry it
GET/api/trpc/products.getBySlugGet By Slug
Input
slugstringrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/products.getCacheStatusGet Cache Status
Input
No input.
Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/products.getOrdersByProductIdGet Orders By Product Id
Input
productIdstringrequiredpagenumberrequireddefault
1limitnumberrequireddefault
20sortstring | nulloptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/products.getProductsByIdsGet Products By Ids
Input
idsstring[]requiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/products.getProductsGet Products
Input
defaultVendorIdstringoptionalpagenumberrequireddefault
0per_pagenumberrequireddefault
10searchstringoptionalstockFilterstringoptionalcategoryFilterstringoptionalactiveFilterstringoptionalbuyableFilterstringoptionalpriceRangeFilterstringoptionalgenericFilterstringoptionalbundleFilterstringoptionalproductTypeFilterenumoptional"SIMPLE" "VARIABLE" "COMPOSITE" "FORMULE" "MENU"subscriptionFilterenumoptional"true" "false"publicationIdstringoptionalbundleIdstringoptionalsortOrderstringrequireddefault
"createdAt:desc"sortMultipleobject[]optionalfieldstringrequireddirectionenumrequired"asc" "desc"excludeIdsstring[]optionalResponse
200 Success. The result is in
result.data.json : objectitemsobject[]optionalidstringoptionalreferencestringoptionalplenigoOfferIdanyoptionalplenigoAccessRightUniqueIdanyoptionalnamestringoptionaldescriptionstringoptionalpricenumberoptionalsalePriceanyoptionalproPriceanyoptionalpurchasePricenumberoptionalstockintegeroptionalstockLedgerintegeroptionalisBuyablebooleanoptionalskustringoptionalisGenericbooleanoptionalmagazineEditionIdanyoptionalsiteIdstringoptionalproductTypestringoptionalmanageStockbooleanoptionallowStockThresholdintegeroptionalsoldIndividuallybooleanoptionalweightanyoptionallengthanyoptionalwidthanyoptionalheightanyoptionalpurchaseNoteanyoptionalmenuOrderanyoptionaldataobjectoptionallastSyncstringoptionalprestashop_idstringoptionalprestashop_dataobjectoptionalmpnstringoptionalupcstringoptionalisbnstringoptionalnamestringoptionalratenumberoptionaldepthintegeroptionalean13stringoptionalpricenumberoptionalunitystringoptionalwidthintegeroptionalactivestringoptionalheightintegeroptionalweightintegeroptionaldate_addstringoptionaldate_updstringoptionalquantityintegeroptionalprice_ttcnumberoptionalreferencestringoptionalid_productstringoptionaldescriptionstringoptionalid_supplierstringoptionallink_rewritestringoptionalsupplier_namestringoptionalid_manufacturerstringoptionalwholesale_pricenumberoptionalbundle_componentsany[]optionaldescription_shortstringoptionallinked_categoriesobject[]optionalmanufacturer_namestringoptionalid_tax_rules_groupintegeroptionalavailable_for_orderstringoptionalid_category_defaultstringoptionalmanufacturerstringoptionaltaxRatenumberoptionalactivebooleanoptionaldefaultVendorIdstringoptionalpackagingTypeIdstringoptionalpackagingQuantityintegeroptionalpackagingUnitstringoptionalsaleDetailanyoptionalsaleQuantitynumberoptionalsaleUnitstringoptionalsaleTypestringoptionaldefaultTemplateIdanyoptionalapprovisionnementintegeroptionalweightUnitanyoptionalrequiresLotNumberbooleanoptionalshowOrderDetailsbooleanoptionalisPerishablebooleanoptionalperishabilityDaysanyoptionaldeliveryDaysanyoptionalspecificOveragePercentanyoptionalcreatedByIdstringoptionalwarehouseIdanyoptionalexternalIdstringoptionalsyncedAtanyoptionallastSyncedAtanyoptionalsourcestringoptionalmainImageIdanyoptionalcreatedAtstringoptionalupdatedAtstringoptionaltenantIdstringoptionaltagsIdanyoptionalisMaterialbooleanoptionalisFinishedProductbooleanoptionalmanufacturingLeadTimeanyoptionalsafetyStockanyoptionalreorderPointanyoptionalmoqanyoptionalmanufacturingCostanyoptionalsubscriptionEnabledbooleanoptionalsubscriptionDurationDaysanyoptionalstripeProductIdanyoptionalstripePriceIdanyoptionalstripeRecurringPriceIdanyoptionalmainImageanyoptionalpackagingTypeobjectoptionalidstringoptionalnamestringoptionalsizestringoptionalorderByQuantityanyoptionaldescriptionstringoptionalcreatedAtstringoptionalupdatedAtstringoptionaltenantIdstringoptionaldefaultVendorobjectoptionalidstringoptionalnamestringoptionaluseStockLedgerbooleanoptionalstockAvailabilityany[]optionalmagazineEditionanyoptionalassignedSubCategoriesobject[]optionalidstringoptionalproductIdstringoptionalsubCategoryIdstringoptionalassignedAtstringoptionalassignedBystringoptionaltenantIdstringoptionalsiteIdstringoptionalsubCategoryobjectoptionalidstringoptionalnamestringoptionalmainCategoryobjectoptional_countobjectoptionalbundleComponentsintegeroptionalprestashopActivebooleanoptionaltotalintegeroptionalpageintegeroptionalper_pageintegeroptionalpagesintegeroptionalTry it
GET/api/trpc/products.getVendorOrdersByProductIdGet Vendor Orders By Product Id
Input
productIdstringrequiredpagenumberrequireddefault
1limitnumberrequireddefault
20Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/products.listGenericLinksList Generic Links
Input
No input.
Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/products.listList
Input
pagenumberrequireddefault
0limitnumberrequireddefault
10searchstringoptionalactivebooleanoptionalisBuyablebooleanoptionalcategoryIdstringoptionalvendorIdstringoptionalpackagingTypeIdstringoptionalsortBystringrequireddefault
"createdAt"sortOrderenumrequired"asc" "desc" · default "desc"Response
200 Success. The result is in
result.data.json : objectitemsobject[]optionalidstringoptionalreferencestringoptionalplenigoOfferIdanyoptionalplenigoAccessRightUniqueIdanyoptionalnamestringoptionaldescriptionstringoptionalpricenumberoptionalsalePriceintegeroptionalproPriceanyoptionalpurchasePriceintegeroptionalstockintegeroptionalstockLedgerintegeroptionalisBuyablebooleanoptionalskustringoptionalisGenericbooleanoptionalmagazineEditionIdanyoptionalsiteIdstringoptionalproductTypestringoptionalmanageStockbooleanoptionallowStockThresholdanyoptionalsoldIndividuallybooleanoptionalweightanyoptionallengthanyoptionalwidthanyoptionalheightanyoptionalpurchaseNoteanyoptionalmenuOrderanyoptionaldataobjectoptionallastSyncstringoptionalprestashop_idstringoptionalreferenceUnitstringoptionalprestashop_dataobjectoptionalmpnstringoptionalupcstringoptionalisbnanyoptionalnamestringoptionalrateintegeroptionaldepthstringoptionalean13stringoptionalpricestringoptionalstatestringoptionalunitystringoptionalwidthstringoptionalactivestringoptionalecotaxstringoptionalheightstringoptionalweightstringoptionalid_langstringoptionalid_shopstringoptionalindexedstringoptionalon_salestringoptionaldate_addstringoptionaldate_updstringoptionallocationstringoptionalquantitystringoptionaltax_namestringoptionalconditionstringoptionalreferencestringoptionalid_productstringoptionalis_virtualstringoptionalmeta_titlestringoptionalshow_pricestringoptionalvisibilitystringoptionaldescriptionstringoptionalfinal_pricestringoptionalid_supplierstringoptionalonline_onlystringoptionaltext_fieldsstringoptionalcustomizablestringoptionallink_rewritestringoptionalout_of_stockstringoptionalproduct_typestringoptionalavailable_nowstringoptionalcache_is_packstringoptionalmeta_keywordsstringoptionalredirect_typestringoptionalsupplier_nameanyoptionalavailable_datestringoptionalshow_conditionstringoptionalavailable_laterstringoptionalid_manufacturerstringoptionalid_shop_defaultstringoptionallow_stock_alertstringoptionalpack_stock_typestringoptionalwholesale_pricestringoptionalmeta_descriptionstringoptionalminimal_quantitystringoptionalunit_price_ratiostringoptionaluploadable_filesstringoptionalbundle_componentsany[]optionaldelivery_in_stockanyoptionaldescription_shortstringoptionallinked_categoriesobject[]optionalmanufacturer_nameanyoptionalquantity_discountstringoptionaldelivery_out_stockanyoptionalid_tax_rules_groupstringoptionalid_type_redirectedstringoptionalsupplier_referencestringoptionalavailable_for_orderstringoptionalid_category_defaultstringoptionallow_stock_thresholdanyoptionalcache_has_attachmentsstringoptionalcache_default_attributestringoptionaladditional_shipping_coststringoptionaladditional_delivery_timesstringoptionaladvanced_stock_managementstringoptionalreferenceSaleQuantityintegeroptionalreferencePurchaseQuantityintegeroptionalmanufacturerstringoptionaltaxRatenumberoptionalactivebooleanoptionaldefaultVendorIdstringoptionalpackagingTypeIdstringoptionalpackagingQuantityintegeroptionalpackagingUnitstringoptionalsaleDetailstringoptionalsaleQuantityintegeroptionalsaleUnitstringoptionalsaleTypestringoptionaldefaultTemplateIdanyoptionalapprovisionnementintegeroptionalweightUnitanyoptionalrequiresLotNumberbooleanoptionalshowOrderDetailsbooleanoptionalisPerishablebooleanoptionalperishabilityDaysanyoptionaldeliveryDaysanyoptionalspecificOveragePercentanyoptionalcreatedByIdstringoptionalwarehouseIdanyoptionalexternalIdstringoptionalsyncedAtstringoptionallastSyncedAtanyoptionalsourcestringoptionalmainImageIdanyoptionalcreatedAtstringoptionalupdatedAtstringoptionaltenantIdstringoptionaltagsIdanyoptionalisMaterialbooleanoptionalisFinishedProductbooleanoptionalmanufacturingLeadTimeanyoptionalsafetyStockanyoptionalreorderPointanyoptionalmoqanyoptionalmanufacturingCostanyoptionalsubscriptionEnabledbooleanoptionalsubscriptionDurationDaysanyoptionalstripeProductIdanyoptionalstripePriceIdanyoptionalstripeRecurringPriceIdanyoptionalmainImageanyoptionalpackagingTypeobjectoptionalidstringoptionalnamestringoptionalsizestringoptionalorderByQuantityanyoptionaldescriptionstringoptionalcreatedAtstringoptionalupdatedAtstringoptionaltenantIdstringoptionaldefaultVendorobjectoptionalidstringoptionalnamestringoptionalassignedSubCategoriesany[]optionalvariantsany[]optionaleffectivePricenumberoptionalpriceLabelstringoptionaltotalintegeroptionalpageintegeroptionallimitintegeroptionalpagesintegeroptionalTry it
POST/api/trpc/products.removeSubCategoryFromProductRemove Sub Category From Product
Input
productIdstring · uuidrequiredsubCategoryIdstring · uuidrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/products.syncIndividualProductSync Individual Product
Input
productIdstring · uuidrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/products.syncProductsSync Products
Input
offsetnumberrequireddefault
0limitnumberrequireddefault
100Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/products.syncProductsStockSync Products Stock
Input
No input.
Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/products.syncSingleProductStockSync Single Product Stock
Input
productIdstringrequiredexternalIdstringoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/products.updateUpdate
Input
namestringoptional≥ 2 chars
descriptionstringoptionalpricenumberoptional≥ 0
proPricenumber | nulloptionalreferencestringoptionalmanufacturerstringoptionaltaxRatenumberoptional0–100
defaultVendorIdstringoptionalpackagingTypeIdstringoptionalpackagingQuantitynumberoptional≥ > 0
packagingUnitstringoptionalsaleDetailstringoptionalsaleQuantitynumberoptional≥ > 0
saleUnitstringoptionalsaleTypestringoptionaldefaultTemplateIdstringoptionalisBuyablebooleanoptionalactivebooleanoptionalmainImageIdstring | nulloptionalproductTypeenumoptional"SIMPLE" "VARIABLE" "COMPOSITE" "FORMULE" "MENU"manageStockbooleanoptionalstockintegeroptional0–9007199254740991
lowStockThresholdintegeroptional0–9007199254740991
soldIndividuallybooleanoptionalweightUnitstringoptionalrequiresLotNumberbooleanoptionalshowOrderDetailsbooleanoptionalisPerishablebooleanoptionalperishabilityDaysintegeroptional1–365
deliveryDaysintegeroptional1–30
specificOveragePercentintegeroptional0–100
weightnumberoptional≥ 0
lengthnumberoptional≥ > 0
widthnumberoptional≥ > 0
heightnumberoptional≥ > 0
purchaseNotestringoptionalmenuOrderintegeroptional-9007199254740991–9007199254740991
isGenericbooleanoptionalidstring · uuidrequiredskipIndexingbooleanrequireddefault
falseimagesstring[]optionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/products.updateStripeLinkUpdate Stripe Link
Input
idstring · uuidrequiredstripeProductIdstring | nulloptionalstripePriceIdstring | nulloptionalstripeRecurringPriceIdstring | nulloptionalsubscriptionEnabledbooleanoptionalsubscriptionDurationDaysinteger | nulloptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/products.updateWithAllNeedsUpdate With All Needs
Input
No input.
Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/products.upsertGenericLinkUpsert Generic Link
Input
idstring · uuidoptionalgenericProductIdstring · uuidrequiredexternalProductIdstringrequired≥ 1 chars
conversionFactornumberrequired≥ > 0
conversionUnitstringoptional≥ 1 chars · default
"kg"notesstringoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
recurringInvoices 10
POST/api/trpc/recurringInvoices.cancelCancel
Input
idstring · uuidrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/recurringInvoices.createCreate
Input
clientIdstring · uuidrequiredfrequencyenumrequired"WEEKLY" "BIWEEKLY" "MONTHLY" "QUARTERLY" "YEARLY"startDateanyrequiredendDateany | nulloptionalitemsobject[]required≥ 1 items
namestringrequired≥ 1 chars
descriptionstringoptionalquantitynumberrequired≥ 1
unitPricenumberrequired≥ 0
taxRatenumberoptional0–1
currencystringrequired3–3 chars · default
"EUR"languagestringrequired2–2 chars · default
"fr"notesstringoptionalfooterstringoptionalpaymentTermsstringoptionalpaymentMethodstringoptionalautoSendbooleanrequireddefault
falseautoReminderbooleanrequireddefault
falsepdfTemplatenumberrequired1–5 · default
3pdfFormatstringoptionaltaxDetailsobjectoptionaldiscountDetailsobjectoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/recurringInvoices.deleteDelete
Input
idstring · uuidrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
GET/api/trpc/recurringInvoices.getGet
Input
idstring · uuidrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
GET/api/trpc/recurringInvoices.getStatsGet Stats
Input
No input.
Response
200 Success. The result is in
result.data.json : objecttotalintegeroptionalactiveintegeroptionalpausedintegeroptionalcancelledintegeroptionalTry it
GET/api/trpc/recurringInvoices.getUpcomingGet Upcoming
Input
daysAheadnumberrequired1–365 · default
30Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/recurringInvoices.listList
Input
pagenumberrequired≥ 1 · default
1limitnumberrequired1–100 · default
20statusenumoptional"ACTIVE" "PAUSED" "CANCELLED" "COMPLETED"clientIdstring · uuidoptionalsearchstringoptionalResponse
200 Success. The result is in
result.data.json : objectitemsany[]optionaltotalintegeroptionalpageintegeroptionallimitintegeroptionaltotalPagesintegeroptionalhasMorebooleanoptionalTry it
POST/api/trpc/recurringInvoices.pausePause
Input
idstring · uuidrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/recurringInvoices.resumeResume
Input
idstring · uuidrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/recurringInvoices.updateUpdate
Input
idstring · uuidrequiredclientIdstring · uuidoptionalfrequencyenumoptional"WEEKLY" "BIWEEKLY" "MONTHLY" "QUARTERLY" "YEARLY"startDateanyoptionalendDateany | nulloptionalitemsobject[]optional≥ 1 items
namestringrequired≥ 1 chars
descriptionstringoptionalquantitynumberrequired≥ 1
unitPricenumberrequired≥ 0
taxRatenumberoptional0–1
currencystringoptional3–3 chars
languagestringoptional2–2 chars
notesstringoptionalfooterstringoptionalpaymentTermsstringoptionalpaymentMethodstringoptionalautoSendbooleanoptionalautoReminderbooleanoptionalpdfTemplatenumberoptional1–5
pdfFormatstringoptionaltaxDetailsobjectoptionaldiscountDetailsobjectoptionalstatusenumoptional"ACTIVE" "PAUSED" "CANCELLED" "COMPLETED"isActivebooleanoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
shipping 43
GET/api/trpc/shipping.calculateEUVATCalculate EUVAT
Input
amountnumberrequired≥ 0
fromCountrystringrequired2–2 chars
toCountrystringrequired2–2 chars
Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/shipping.calculateShippingRatesCalculate Shipping Rates
Input
originobjectrequiredpostalCodestringrequiredcountrystringrequired2–2 chars
destinationobjectrequiredpostalCodestringrequiredcountrystringrequired2–2 chars
packagesobject[]requiredweightnumberrequired≥ > 0
lengthnumberoptional≥ > 0
widthnumberoptional≥ > 0
heightnumberoptional≥ > 0
currencystringrequired3–3 chars
carrierIdsstring · uuid[]optionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/shipping.colissimoCreateLabelColissimo Create Label
Input
shipmentIdstring · uuidrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
GET/api/trpc/shipping.colissimoGetRatesColissimo Get Rates
Input
originobjectrequiredpostalCodestringrequiredcountrystringrequired2–2 chars
destinationobjectrequiredpostalCodestringrequiredcountrystringrequired2–2 chars
weightnumberrequired≥ > 0
Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/shipping.colissimoSearchPickupPointsColissimo Search Pickup Points
Input
addressstringrequiredpostalCodestringrequiredcitystringrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/shipping.colissimoTrackShipmentColissimo Track Shipment
Input
trackingNumberstringrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/shipping.createRateCreate Rate
Input
carrierIdstring · uuidrequiredserviceIdstring · uuidrequiredzoneIdstring · uuidrequirednamestringoptionaltypeenumrequired"FLAT_RATE" "WEIGHT_BASED" "VOLUME_BASED" "DISTANCE_BASED" "HYBRID"weightMinnumberrequired≥ 0
weightMaxnumberrequired≥ > 0
baseRatenumberrequired≥ 0
perKgRatenumberoptional≥ 0
volumeMinnumberoptional≥ 0
volumeMaxnumberoptional≥ > 0
perVolumeRatenumberoptional≥ 0
handlingFeenumberoptional≥ 0
fuelSurchargenumberoptional0–100
insuranceFeenumberoptional≥ 0
corsicaSurchargenumberoptional≥ 0
domTomSurchargenumberoptional≥ 0
ruralSurchargenumberoptional≥ 0
pickupPointDiscountnumberoptional≥ 0
vatRatenumberrequired0–100
vatIncludedbooleanrequiredisActivebooleanrequiredvalidFromanyoptionalvalidToanyoptionalminOrderValuenumberoptional≥ 0
maxOrderValuenumberoptional≥ > 0
Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/shipping.createServiceCreate Service
Input
carrierIdstring · uuidrequirednamestringrequired≥ 1 chars
codestringrequired≥ 1 chars
typeenumrequired"STANDARD" "EXPRESS" "ECONOMY" "PICKUP_POINT" "SAME_DAY" "APPOINTMENT"descriptionstringoptionalestimatedDaysMinintegerrequired1–9007199254740991
estimatedDaysMaxintegerrequired1–9007199254740991
trackingIncludedbooleanrequiredinsuranceIncludedbooleanrequiredsignatureRequiredbooleanrequiredisActivebooleanrequiredavailableZonesstring[]requiredpickupPointServicebooleanrequiredappointmentRequiredbooleanrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/shipping.createShipmentCreate Shipment
Input
orderIdstring · uuidrequiredcarrierIdstring · uuidrequiredserviceIdstring · uuidrequiredpickupPointIdstring · uuidoptionalpackagesobject[]requiredweightnumberrequired≥ > 0
lengthnumberoptional≥ > 0
widthnumberoptional≥ > 0
heightnumberoptional≥ > 0
senderAddressobjectrequiredrecipientAddressobjectrequiredcurrencystringrequired3–3 chars
instructionsstringoptionalrequiresSignaturebooleanrequireddefault
falseinsuranceValuenumberoptional≥ 0
Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/shipping.createShippingCarrierCreate Shipping Carrier
Input
namestringrequired≥ 1 chars
codestringrequired≥ 1 chars
descriptionstringoptionallogoUrlstring · urioptionalwebsiteUrlstring · urioptionalstatusenumrequired"ACTIVE" "INACTIVE" "TESTING" "SUSPENDED"priorityintegerrequired0–9007199254740991
apiEndpointstring · urioptionalapiKeystringoptionalapiSecretstringoptionaltestModebooleanrequiredcountryCodestringrequired2–2 chars
euCoveragebooleanrequiredinternationalCoveragebooleanrequiredpickupPointsSupportedbooleanrequiredtrackingSupportedbooleanrequiredlabelGenerationSupportedbooleanrequiredcorsicaSupportedbooleanrequireddomTomSupportedbooleanrequiredappointmentDeliverybooleanrequiredmaxWeightnumberoptional≥ > 0
maxLengthnumberoptional≥ > 0
maxWidthnumberoptional≥ > 0
maxHeightnumberoptional≥ > 0
Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/shipping.createZoneCreate Zone
Input
namestringrequired≥ 1 chars
codestringrequired≥ 1 chars
typeenumrequired"DOMESTIC" "CORSICA" "DOM_TOM" "EU" "EUROPE_NON_EU" "INTERNATIONAL"descriptionstringoptionalcountriesstring[]requiredregionsstring[]requiredpostalCodeRangesobjectoptionalincludesCorsicabooleanrequiredincludesDomTombooleanrequiredruralDeliveryHandlingbooleanrequiredisActivebooleanrequiredpriorityintegerrequired0–9007199254740991
freeShippingThresholdnumberoptional≥ 0
maxWeightnumberoptional≥ > 0
maxDimensionsobjectoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/shipping.deleteRateDelete Rate
Input
rateIdstring · uuidrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/shipping.deleteServiceDelete Service
Input
serviceIdstring · uuidrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/shipping.deleteShippingCarrierDelete Shipping Carrier
Input
carrierIdstring · uuidrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/shipping.deleteZoneDelete Zone
Input
zoneIdstring · uuidrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/shipping.generateBulkLabelsGenerate Bulk Labels
Input
shipmentIdsstring · uuid[]requiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/shipping.generateLabelGenerate Label
Input
shipmentIdstring · uuidrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
GET/api/trpc/shipping.getCarrierGet Carrier
Input
No input.
Response
200 Success. The result is in
result.data.json : object[]idstringoptionalcarrierIdstringoptionaltenantIdstringoptionalsiteIdstringoptionalnamestringoptionalcodestringoptionaltypestringoptionaldescriptionstringoptionalestimatedDaysMinintegeroptionalestimatedDaysMaxintegeroptionaltrackingIncludedbooleanoptionalinsuranceIncludedbooleanoptionalsignatureRequiredbooleanoptionalisActivebooleanoptionalavailableZonesstring[]optionalpickupPointServicebooleanoptionalappointmentRequiredbooleanoptionalcreatedAtstringoptionalupdatedAtstringoptionalcarrierobjectoptionalidstringoptionalnamestringoptionalcodestringoptionalratesobject[]optionalidstringoptionaltenantIdstringoptionalsiteIdstringoptionalcarrierIdstringoptionalserviceIdstringoptionalzoneIdstringoptionalnamestringoptionaltypestringoptionalweightMinstringoptionalweightMaxstringoptionalbaseRatestringoptionalperKgRatestringoptionalvolumeMinanyoptionalvolumeMaxanyoptionalperVolumeRateanyoptionalhandlingFeestringoptionalfuelSurchargestringoptionalinsuranceFeestringoptionalcorsicaSurchargestringoptionaldomTomSurchargestringoptionalruralSurchargestringoptionalpickupPointDiscountstringoptionalvatRatestringoptionalvatIncludedbooleanoptionalisActivebooleanoptionalvalidFromstringoptionalvalidToanyoptionalminOrderValuestringoptionalmaxOrderValueanyoptionalcreatedAtstringoptionalupdatedAtstringoptionalzoneobjectoptionalidstringoptionaltenantIdstringoptionalsiteIdstringoptionalnamestringoptionalcodestringoptionaltypestringoptionaldescriptionstringoptionalcountriesstring[]optionalregionsany[]optionalpostalCodeRangesanyoptionalincludesCorsicabooleanoptionalincludesDomTombooleanoptionalruralDeliveryHandlingbooleanoptionalisActivebooleanoptionalpriorityintegeroptionalfreeShippingThresholdstringoptionalmaxWeightstringoptionalmaxDimensionsanyoptionalcreatedAtstringoptionalupdatedAtstringoptionalTry it
GET/api/trpc/shipping.getCostAnalysisGet Cost Analysis
Input
startDateanyrequiredendDateanyrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/shipping.getDeliveryPerformanceGet Delivery Performance
Input
startDateanyrequiredendDateanyrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/shipping.getPerformanceDashboardGet Performance Dashboard
Input
startDateanyrequiredendDateanyrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/shipping.getPickupPointsGet Pickup Points
Input
carrierIdstring · uuidrequiredaddressstringrequiredpostalCodestringrequiredcitystringrequiredcountrystringrequired2–2 chars
Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
GET/api/trpc/shipping.getPrintJobsGet Print Jobs
Input
pageintegerrequired1–9007199254740991 · default
1limitintegerrequired1–100 · default
50Response
200 Success. The result is in
result.data.json : objectsuccessbooleanoptionalprintJobsany[]optionaltotalintegeroptionalhasMorebooleanoptionalTry it
GET/api/trpc/shipping.getQuickEstimateGet Quick Estimate
Input
weightnumberrequired≥ > 0
carrierIdstring · uuidoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/shipping.getRatesGet Rates
Input
No input.
Response
200 Success. The result is in
result.data.json : object[]idstringoptionaltenantIdstringoptionalsiteIdstringoptionalcarrierIdstringoptionalserviceIdstringoptionalzoneIdstringoptionalnamestringoptionaltypestringoptionalweightMinstringoptionalweightMaxstringoptionalbaseRatestringoptionalperKgRatestringoptionalvolumeMinanyoptionalvolumeMaxanyoptionalperVolumeRateanyoptionalhandlingFeestringoptionalfuelSurchargestringoptionalinsuranceFeestringoptionalcorsicaSurchargestringoptionaldomTomSurchargestringoptionalruralSurchargestringoptionalpickupPointDiscountstringoptionalvatRatestringoptionalvatIncludedbooleanoptionalisActivebooleanoptionalvalidFromstringoptionalvalidToanyoptionalminOrderValuestringoptionalmaxOrderValueanyoptionalcreatedAtstringoptionalupdatedAtstringoptionalzoneobjectoptionalidstringoptionalnamestringoptionalcountriesstring[]optionalserviceobjectoptionalidstringoptionalnamestringoptionaltypestringoptionalcarrierobjectoptionalidstringoptionalnamestringoptionalTry it
GET/api/trpc/shipping.getShipmentGet Shipment
Input
shipmentIdstring · uuidrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
GET/api/trpc/shipping.getShipmentsGet Shipments
Input
pageintegerrequired1–9007199254740991 · default
1limitintegerrequired1–100 · default
20statusstringoptionalcarrierIdstring · uuidoptionaldateFromanyoptionaldateToanyoptionalsearchstringoptionalResponse
200 Success. The result is in
result.data.json : objectshipmentsany[]optionaltotalintegeroptionalpageintegeroptionallimitintegeroptionalhasMorebooleanoptionalTry it
GET/api/trpc/shipping.getShippingAnalyticsGet Shipping Analytics
Input
startDateanyrequiredendDateanyrequiredcarrierIdstring · uuidoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/shipping.getShippingCarriersGet Shipping Carriers
Input
includeInactivebooleanrequireddefault
falseResponse
200 Success. The result is in
result.data.json : object[]idstringoptionaltenantIdstringoptionalsiteIdstringoptionalnamestringoptionalcodestringoptionaldescriptionstringoptionallogoUrlanyoptionalwebsiteUrlanyoptionalstatusstringoptionalpriorityintegeroptionalapiEndpointanyoptionalapiKeyanyoptionalapiSecretanyoptionaltestModebooleanoptionalcountryCodestringoptionaleuCoveragebooleanoptionalinternationalCoveragebooleanoptionalpickupPointsSupportedbooleanoptionaltrackingSupportedbooleanoptionallabelGenerationSupportedbooleanoptionalcorsicaSupportedbooleanoptionaldomTomSupportedbooleanoptionalappointmentDeliverybooleanoptionalmaxWeightstringoptionalmaxLengthanyoptionalmaxWidthanyoptionalmaxHeightanyoptionalcreatedAtstringoptionalupdatedAtstringoptionalservicesobject[]optionalidstringoptionalnamestringoptionaltypestringoptionalTry it
GET/api/trpc/shipping.getShippingConfigurationGet Shipping Configuration
Input
includeInactivebooleanrequireddefault
falseResponse
200 Success. The result is in
result.data.json : object[]idstringoptionaltenantIdstringoptionalsiteIdstringoptionalnamestringoptionalcodestringoptionaldescriptionstringoptionallogoUrlanyoptionalwebsiteUrlanyoptionalstatusstringoptionalpriorityintegeroptionalapiEndpointanyoptionalapiKeyanyoptionalapiSecretanyoptionaltestModebooleanoptionalcountryCodestringoptionaleuCoveragebooleanoptionalinternationalCoveragebooleanoptionalpickupPointsSupportedbooleanoptionaltrackingSupportedbooleanoptionallabelGenerationSupportedbooleanoptionalcorsicaSupportedbooleanoptionaldomTomSupportedbooleanoptionalappointmentDeliverybooleanoptionalmaxWeightstringoptionalmaxLengthanyoptionalmaxWidthanyoptionalmaxHeightanyoptionalcreatedAtstringoptionalupdatedAtstringoptionalservicesobject[]optionalidstringoptionalnamestringoptionaltypestringoptionalTry it
GET/api/trpc/shipping.getShippingZonesGet Shipping Zones
Input
No input.
Response
200 Success. The result is in
result.data.json : object[]idstringoptionaltenantIdstringoptionalsiteIdstringoptionalnamestringoptionalcodestringoptionaltypestringoptionaldescriptionstringoptionalcountriesstring[]optionalregionsany[]optionalpostalCodeRangesanyoptionalincludesCorsicabooleanoptionalincludesDomTombooleanoptionalruralDeliveryHandlingbooleanoptionalisActivebooleanoptionalpriorityintegeroptionalfreeShippingThresholdstringoptionalmaxWeightstringoptionalmaxDimensionsanyoptionalcreatedAtstringoptionalupdatedAtstringoptional_countobjectoptionalratesintegeroptionalTry it
GET/api/trpc/shipping.getZonesGet Zones
Input
No input.
Response
200 Success. The result is in
result.data.json : object[]idstringoptionaltenantIdstringoptionalsiteIdstringoptionalnamestringoptionalcodestringoptionaltypestringoptionaldescriptionstringoptionalcountriesstring[]optionalregionsany[]optionalpostalCodeRangesanyoptionalincludesCorsicabooleanoptionalincludesDomTombooleanoptionalruralDeliveryHandlingbooleanoptionalisActivebooleanoptionalpriorityintegeroptionalfreeShippingThresholdstringoptionalmaxWeightstringoptionalmaxDimensionsanyoptionalcreatedAtstringoptionalupdatedAtstringoptional_countobjectoptionalratesintegeroptionalTry it
GET/api/trpc/shipping.performComplianceCheckPerform Compliance Check
Input
shipmentIdstring · uuidrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/shipping.processBulkOrdersProcess Bulk Orders
Input
orderIdsstring · uuid[]requiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/shipping.searchPickupPointsSearch Pickup Points
Input
siteSlugstringrequiredaddressstringrequiredmaxResultsintegerrequired1–20 · default
10Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/shipping.sendShippingNotificationSend Shipping Notification
Input
shipmentIdstring · uuidrequiredtypeenumrequired"CREATED" "SHIPPED" "IN_TRANSIT" "DELIVERED" "EXCEPTION"Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/shipping.updateCarrierRatesUpdate Carrier Rates
Input
carrierIdstring · uuidrequiredratesobject[]requiredcarrierIdstring · uuidrequiredserviceIdstring · uuidrequiredzoneIdstring · uuidrequirednamestringoptionaltypeenumrequired"FLAT_RATE" "WEIGHT_BASED" "VOLUME_BASED" "DISTANCE_BASED" "HYBRID"weightMinnumberrequired≥ 0
weightMaxnumberrequired≥ > 0
baseRatenumberrequired≥ 0
perKgRatenumberoptional≥ 0
volumeMinnumberoptional≥ 0
volumeMaxnumberoptional≥ > 0
perVolumeRatenumberoptional≥ 0
handlingFeenumberoptional≥ 0
fuelSurchargenumberoptional0–100
insuranceFeenumberoptional≥ 0
corsicaSurchargenumberoptional≥ 0
domTomSurchargenumberoptional≥ 0
ruralSurchargenumberoptional≥ 0
pickupPointDiscountnumberoptional≥ 0
vatRatenumberrequired0–100
vatIncludedbooleanrequiredisActivebooleanrequiredvalidFromanyoptionalvalidToanyoptionalminOrderValuenumberoptional≥ 0
maxOrderValuenumberoptional≥ > 0
Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/shipping.updateRateUpdate Rate
Input
carrierIdstring · uuidoptionalserviceIdstring · uuidoptionalzoneIdstring · uuidoptionalnamestringoptionaltypeenumoptional"FLAT_RATE" "WEIGHT_BASED" "VOLUME_BASED" "DISTANCE_BASED" "HYBRID"weightMinnumberoptional≥ 0
weightMaxnumberoptional≥ > 0
baseRatenumberoptional≥ 0
perKgRatenumberoptional≥ 0
volumeMinnumberoptional≥ 0
volumeMaxnumberoptional≥ > 0
perVolumeRatenumberoptional≥ 0
handlingFeenumberoptional≥ 0
fuelSurchargenumberoptional0–100
insuranceFeenumberoptional≥ 0
corsicaSurchargenumberoptional≥ 0
domTomSurchargenumberoptional≥ 0
ruralSurchargenumberoptional≥ 0
pickupPointDiscountnumberoptional≥ 0
vatRatenumberoptional0–100
vatIncludedbooleanoptionalisActivebooleanoptionalvalidFromanyoptionalvalidToanyoptionalminOrderValuenumberoptional≥ 0
maxOrderValuenumberoptional≥ > 0
rateIdstring · uuidrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/shipping.updateServiceUpdate Service
Input
carrierIdstring · uuidoptionalnamestringoptional≥ 1 chars
codestringoptional≥ 1 chars
typeenumoptional"STANDARD" "EXPRESS" "ECONOMY" "PICKUP_POINT" "SAME_DAY" "APPOINTMENT"descriptionstringoptionalestimatedDaysMinintegeroptional1–9007199254740991
estimatedDaysMaxintegeroptional1–9007199254740991
trackingIncludedbooleanoptionalinsuranceIncludedbooleanoptionalsignatureRequiredbooleanoptionalisActivebooleanoptionalavailableZonesstring[]optionalpickupPointServicebooleanoptionalappointmentRequiredbooleanoptionalserviceIdstring · uuidrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/shipping.updateShippingCarrierUpdate Shipping Carrier
Input
namestringoptional≥ 1 chars
codestringoptional≥ 1 chars
descriptionstringoptionallogoUrlstring · urioptionalwebsiteUrlstring · urioptionalstatusenumoptional"ACTIVE" "INACTIVE" "TESTING" "SUSPENDED"priorityintegeroptional0–9007199254740991
apiEndpointstring · urioptionalapiKeystringoptionalapiSecretstringoptionaltestModebooleanoptionalcountryCodestringoptional2–2 chars
euCoveragebooleanoptionalinternationalCoveragebooleanoptionalpickupPointsSupportedbooleanoptionaltrackingSupportedbooleanoptionallabelGenerationSupportedbooleanoptionalcorsicaSupportedbooleanoptionaldomTomSupportedbooleanoptionalappointmentDeliverybooleanoptionalmaxWeightnumberoptional≥ > 0
maxLengthnumberoptional≥ > 0
maxWidthnumberoptional≥ > 0
maxHeightnumberoptional≥ > 0
carrierIdstring · uuidrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/shipping.updateZoneUpdate Zone
Input
namestringoptional≥ 1 chars
codestringoptional≥ 1 chars
typeenumoptional"DOMESTIC" "CORSICA" "DOM_TOM" "EU" "EUROPE_NON_EU" "INTERNATIONAL"descriptionstringoptionalcountriesstring[]optionalregionsstring[]optionalpostalCodeRangesobjectoptionalincludesCorsicabooleanoptionalincludesDomTombooleanoptionalruralDeliveryHandlingbooleanoptionalisActivebooleanoptionalpriorityintegeroptional0–9007199254740991
freeShippingThresholdnumberoptional≥ 0
maxWeightnumberoptional≥ > 0
maxDimensionsobjectoptionalzoneIdstring · uuidrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
GET/api/trpc/shipping.validateAddressValidate Address
Input
addressobjectrequiredstreetstringrequiredcitystringrequiredpostalCodestringrequiredcountrystringrequired2–2 chars
Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/shipping.validateCarrierAPIValidate Carrier API
Input
carrierIdstring · uuidrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
subscriptions 2
GET/api/trpc/subscriptions.cancelCancel
Input
subscriptionIdstring · uuidrequirednewAmountnumberrequired≥ > 0
Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/subscriptions.createCreate
Input
No input.
Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
tiers 29
GET/api/trpc/tiers.checkTiersExistenceCheck Tiers Existence
Input
criteriaobjectrequiredsiretstringoptionalsirenstringoptionalemailstring · emailoptionalnamestringoptionalResponse
200 Success. The result is in
result.data.json : objectexistsbooleanoptionaltiersanyoptionalmatchesany[]optionalTry it
POST/api/trpc/tiers.createActivityCreate Activity
Input
tiersIdstring · uuidrequiredtypeenumrequired"CALL" "EMAIL" "MEETING" "TASK" "NOTE" "DOCUMENT_SHARED" "QUOTE_SENT" "PROPOSAL_SENT" "CONTRACT_SIGNED" "PAYMENT_RECEIVED" …subjectstringrequired≥ 1 chars
descriptionstringoptionalscheduledAtanyoptionalcontactIdstring · uuidoptionalopportunityIdstring · uuidoptionaleventIdstring · uuidoptionalpriorityenumrequired"LOW" "MEDIUM" "HIGH" "URGENT" · default "MEDIUM"metadataobjectoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/tiers.createAddressCreate Address
Input
tiersIdstring · uuidrequiredtypeenumrequired"BILLING" "SHIPPING" "HEADQUARTERS" "BRANCH" · default "BILLING"namestringoptionalstreetstringrequired≥ 1 chars
street2stringoptionalcitystringrequired≥ 1 chars
postalCodestringrequired≥ 1 chars
countrystringrequired2–2 chars · default
"FR"regionstringoptionallatitudenumberoptionallongitudenumberoptionalisDefaultbooleanrequireddefault
falseisActivebooleanrequireddefault
truemetadataobjectoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/tiers.createContactCreate Contact
Input
tiersIdstring · uuidrequiredfirstNamestringrequired≥ 1 chars
lastNamestringrequired≥ 1 chars
emailstring · emailoptionalphonestringoptionalmobilestringoptionalrolestringoptionaltitlestringoptionaldepartmentstringoptionalisPrimarybooleanrequireddefault
falsetagsstring[]optionalmetadataobjectoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/tiers.createCustomFieldCreate Custom Field
Input
object
Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/tiers.createOpportunityCreate Opportunity
Input
tiersIdstring · uuidrequirednamestringrequired≥ 1 chars
descriptionstringoptionalstatusenumoptional"LEAD" "QUALIFIED" "PROPOSAL" "NEGOTIATION" "CLOSED_WON" "CLOSED_LOST"sourceenumoptional"WEBSITE" "REFERRAL" "COLD_CALL" "EMAIL_CAMPAIGN" "SOCIAL_MEDIA" "TRADE_SHOW" "PARTNER" "OTHER"stagestringoptionalvaluenumberoptional≥ > 0
probabilitynumberrequired0–100 · default
0expectedCloseDateanyoptionalprimaryContactIdstring · uuidoptionalassignedToIdstring · uuidrequiredlostReasonstringoptionalcompetitorInfostringoptionalnextActionstringoptionalnextActionDateanyoptionalmetadataobjectoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/tiers.createTiersCreate Tiers
Input
namestringrequired≥ 1 chars
emailstring · emailoptionalphonestringoptionalsiretstringoptionalsirenstringoptionaltvastringoptionaltypeenumrequired"CLIENT" "FOURNISSEUR" "PROSPECT" "PARTENAIRE" · default "CLIENT"statusenumrequired"ACTIVE" "INACTIVE" "ARCHIVED" · default "ACTIVE"industrystringoptionalcompanySizestringoptionalannualRevenuestringoptionalwebsitestring · urioptionaldescriptionstringoptionalcreditLimitnumberoptional≥ 0
creditUsednumberoptional≥ 0
paymentTermsstringoptionalpreferredCurrencyenumrequired"EUR" "USD" "GBP" · default "EUR"taxExemptbooleanrequireddefault
falsecreditScorenumberoptional0–1000
riskLevelenumoptional"LOW" "MEDIUM" "HIGH"tagsstring[]optionalmetadataobjectoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/tiers.deleteTiersDelete Tiers
Input
idstring · uuidrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
GET/api/trpc/tiers.getActivitiesGet Activities
Input
tiersIdstring · uuidoptionalcontactIdstring · uuidoptionaltypeenum[]optionalstatusenum[]optionalpriorityenum[]optionaldateFromanyoptionaldateToanyoptionalassignedToIdstring · uuidoptionalpagenumberrequired≥ 1 · default
1limitnumberrequired1–50 · default
20sortByenumrequired"createdAt" "scheduledAt" "priority" "type" · default "createdAt"sortOrderenumrequired"asc" "desc" · default "desc"Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/tiers.getAllTiersGet All Tiers
Input
pagenumberrequired≥ 1 · default
1limitnumberrequired1–100 · default
20searchstringoptionaltypeenumoptional"CLIENT" "FOURNISSEUR" "PROSPECT" "PARTENAIRE"statusenumoptional"ACTIVE" "INACTIVE" "ARCHIVED"sortByenumrequired"name" "createdAt" "updatedAt" · default "name"sortOrderenumrequired"asc" "desc" · default "asc"Response
200 Success. The result is in
result.data.json : objecttiersobject[]optionalidstringoptionalnamestringoptionalupdatedAtstringoptionalcreatedAtstringoptionalsyncedAtstringoptionalsuperiorIdanyoptionalrefstringoptionalexternalIdstringoptionalexternalRefstringoptionalexternalRefComptableanyoptionaldescriptionstringoptionalnumSirenanyoptionalnumSiretanyoptionalnumTvaanyoptionalcodeNafanyoptionalcommercialanyoptionalstatutstringoptionalsourcestringoptionalecheanceanyoptionalmodeDePaiementanyoptionalmainActivityanyoptionalpaymentConditionIdanyoptionaldeliveryCommentsanyoptionaldate_creationstringoptionaldate_dernier_appelTeleproanyoptionaldate_dernier_appelCommercialanyoptionaldate_dernier_rdvanyoptionaldate_prochain_rdvanyoptionalrdvPrisanyoptionalribanyoptionalextraDataobjectoptionalemailstringoptionaloptinbooleanoptionalactivebooleanoptionalid_langintegeroptionalid_shopintegeroptionaldate_addstringoptionaldate_updstringoptionallastSyncstringoptionallastnamestringoptionaladdressesany[]optionalfirstnamestringoptionalnewsletterbooleanoptionalid_customerintegeroptionalid_shop_groupintegeroptionalgeocodeanyoptionaladdressL1anyoptionaladdressL2anyoptionaladdressCPanyoptionaladdressCommuneanyoptionaladdressDepartementanyoptionallatitudeanyoptionallongitudeanyoptionaluserIdstringoptionalcreatedByIdstringoptionalassignedToIdanyoptionaltenantIdstringoptionalsiteIdstringoptionallastSyncedAtanyoptionalaccountManagerIdanyoptionalannualRevenueanyoptionalaverageOrderValuestringoptionalcompanySizeanyoptionalcreditCheckDateanyoptionalcreditLimitanyoptionalcreditScoreanyoptionalcreditUsedstringoptionalfirstOrderDateanyoptionalindustryanyoptionallanguagestringoptionallastOrderDateanyoptionallastQualificationDateanyoptionalleadScoreintegeroptionallifetimeValuestringoptionaloutstandingBalancestringoptionalparentCompanyIdanyoptionalpartnerTypeanyoptionalpaymentTermsanyoptionalpreferredContactMethodstringoptionalpreferredCurrencystringoptionalqualificationNotesanyoptionalqualificationStatusanyoptionalsocialMediaUrlsanyoptionaltaxExemptbooleanoptionaltimezoneanyoptionaltotalRevenuestringoptionalwebsiteanyoptionalcontactsany[]optionalfinancialany[]optionaltotalintegeroptionalpageintegeroptionallimitintegeroptionalhasMorebooleanoptionalTry it
GET/api/trpc/tiers.getFinancialsByTiersExternalIdsGet Financials By Tiers External Ids
Input
externalIdsstring[]requiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/tiers.getOpportunitiesGet Opportunities
Input
tiersIdstring · uuidoptionalstatusenum[]optionalstagestring[]optionalassignedToIdstring · uuidoptionalvalueMinnumberoptionalvalueMaxnumberoptionalprobabilityMinnumberoptionalprobabilityMaxnumberoptionalexpectedCloseFromanyoptionalexpectedCloseToanyoptionalpagenumberrequired≥ 1 · default
1limitnumberrequired1–50 · default
20sortByenumrequired"createdAt" "expectedCloseDate" "value" "probability" · default "createdAt"sortOrderenumrequired"asc" "desc" · default "desc"Response
200 Success. The result is in
result.data.json : objectopportunitiesany[]optionaltotalintegeroptionalpageintegeroptionallimitintegeroptionalhasMorebooleanoptionalsummaryanyoptionalTry it
GET/api/trpc/tiers.getTiersActivitiesByIdGet Tiers Activities By Id
Input
idstring · uuidrequiredpagenumberrequired≥ 1 · default
1limitnumberrequired1–50 · default
20Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
GET/api/trpc/tiers.getTiersByIdGet Tiers By Id
Input
idstring · uuidrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
GET/api/trpc/tiers.getTiersByIdsGet Tiers By Ids
Input
idsstring · uuid[]requiredResponse
200 Success. The result is in
result.data.json : objecttiersany[]optionaltotalintegeroptionalTry it
GET/api/trpc/tiers.getTiersByRefGet Tiers By Ref
Input
refstringrequiredResponse
200 Success. The result is in
result.data.json : objectidstringoptionalnamestringoptionalupdatedAtstringoptionalcreatedAtstringoptionalsyncedAtstringoptionalsuperiorIdanyoptionalrefstringoptionalexternalIdstringoptionalexternalRefstringoptionalexternalRefComptableanyoptionaldescriptionstringoptionalnumSirenanyoptionalnumSiretstringoptionalnumTvastringoptionalcodeNafanyoptionalcommercialanyoptionalstatutstringoptionalsourcestringoptionalecheanceanyoptionalmodeDePaiementstringoptionalmainActivitystringoptionalpaymentConditionIdanyoptionaldeliveryCommentsstringoptionaldate_creationstringoptionaldate_dernier_appelTeleproanyoptionaldate_dernier_appelCommercialanyoptionaldate_dernier_rdvanyoptionaldate_prochain_rdvanyoptionalrdvPrisanyoptionalribanyoptionalextraDataobjectoptionalemailstringoptionaloptinbooleanoptionalactivebooleanoptionalid_langintegeroptionalid_shopintegeroptionaldate_addstringoptionaldate_updstringoptionallastSyncstringoptionallastnamestringoptionaladdressesobject[]optionalcitystringoptionalphonestringoptionaladdressstringoptionalcountrystringoptionaladdress2stringoptionalpostcodestringoptionalphone_mobilestringoptionalfirstnamestringoptionalnewsletterbooleanoptionalid_customerintegeroptionalid_shop_groupintegeroptionalgeocodeanyoptionaladdressL1stringoptionaladdressL2stringoptionaladdressCPstringoptionaladdressCommunestringoptionaladdressDepartementstringoptionallatitudeanyoptionallongitudeanyoptionaluserIdstringoptionalcreatedByIdstringoptionalassignedToIdanyoptionaltenantIdstringoptionalsiteIdstringoptionallastSyncedAtanyoptionalaccountManagerIdanyoptionalannualRevenueanyoptionalaverageOrderValuestringoptionalcompanySizeanyoptionalcreditCheckDateanyoptionalcreditLimitanyoptionalcreditScoreanyoptionalcreditUsedstringoptionalfirstOrderDateanyoptionalindustryanyoptionallanguagestringoptionallastOrderDateanyoptionallastQualificationDateanyoptionalleadScoreintegeroptionallifetimeValuestringoptionaloutstandingBalancestringoptionalparentCompanyIdanyoptionalpartnerTypeanyoptionalpaymentTermsanyoptionalpreferredContactMethodstringoptionalpreferredCurrencystringoptionalqualificationNotesanyoptionalqualificationStatusanyoptionalsocialMediaUrlsanyoptionaltaxExemptbooleanoptionaltimezoneanyoptionaltotalRevenuestringoptionalwebsiteanyoptionalcontactsany[]optionalActivitiesany[]optionalOpportunitiesany[]optionalfinancialany[]optionalDocumentsany[]optionalTry it
GET/api/trpc/tiers.getTiersBySiretGet Tiers By Siret
Input
siretstringrequiredResponse
200 Success. The result is in
result.data.json : objectidstringoptionalnamestringoptionalupdatedAtstringoptionalcreatedAtstringoptionalsyncedAtstringoptionalsuperiorIdanyoptionalrefstringoptionalexternalIdstringoptionalexternalRefstringoptionalexternalRefComptableanyoptionaldescriptionstringoptionalnumSirenanyoptionalnumSiretstringoptionalnumTvastringoptionalcodeNafanyoptionalcommercialanyoptionalstatutstringoptionalsourcestringoptionalecheanceanyoptionalmodeDePaiementstringoptionalmainActivitystringoptionalpaymentConditionIdanyoptionaldeliveryCommentsstringoptionaldate_creationstringoptionaldate_dernier_appelTeleproanyoptionaldate_dernier_appelCommercialanyoptionaldate_dernier_rdvanyoptionaldate_prochain_rdvanyoptionalrdvPrisanyoptionalribanyoptionalextraDataobjectoptionalemailstringoptionaloptinbooleanoptionalactivebooleanoptionalid_langintegeroptionalid_shopintegeroptionaldate_addstringoptionaldate_updstringoptionallastSyncstringoptionallastnamestringoptionaladdressesobject[]optionalcitystringoptionalphonestringoptionaladdressstringoptionalcountrystringoptionaladdress2stringoptionalpostcodestringoptionalphone_mobilestringoptionalfirstnamestringoptionalnewsletterbooleanoptionalid_customerintegeroptionalid_shop_groupintegeroptionalgeocodeanyoptionaladdressL1stringoptionaladdressL2stringoptionaladdressCPstringoptionaladdressCommunestringoptionaladdressDepartementstringoptionallatitudeanyoptionallongitudeanyoptionaluserIdstringoptionalcreatedByIdstringoptionalassignedToIdanyoptionaltenantIdstringoptionalsiteIdstringoptionallastSyncedAtanyoptionalaccountManagerIdanyoptionalannualRevenueanyoptionalaverageOrderValuestringoptionalcompanySizeanyoptionalcreditCheckDateanyoptionalcreditLimitanyoptionalcreditScoreanyoptionalcreditUsedstringoptionalfirstOrderDateanyoptionalindustryanyoptionallanguagestringoptionallastOrderDateanyoptionallastQualificationDateanyoptionalleadScoreintegeroptionallifetimeValuestringoptionaloutstandingBalancestringoptionalparentCompanyIdanyoptionalpartnerTypeanyoptionalpaymentTermsanyoptionalpreferredContactMethodstringoptionalpreferredCurrencystringoptionalqualificationNotesanyoptionalqualificationStatusanyoptionalsocialMediaUrlsanyoptionaltaxExemptbooleanoptionaltimezoneanyoptionaltotalRevenuestringoptionalwebsiteanyoptionalTry it
GET/api/trpc/tiers.getTiersContactsByIdGet Tiers Contacts By Id
Input
idstring · uuidrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
GET/api/trpc/tiers.getTiersEnhancedGet Tiers Enhanced
Input
idstring · uuidrequiredincludeContactsbooleanrequireddefault
trueincludeAddressesbooleanrequireddefault
trueincludeActivitiesbooleanrequireddefault
falseincludeOpportunitiesbooleanrequireddefault
falseincludeFinancialsbooleanrequireddefault
trueincludeFilesbooleanrequireddefault
falseactivityLimitnumberrequired1–20 · default
5opportunityLimitnumberrequired1–10 · default
5Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
GET/api/trpc/tiers.getTiersFilesByIdGet Tiers Files By Id
Input
idstring · uuidrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
GET/api/trpc/tiers.getTiersGet Tiers
Input
pagenumberrequired≥ 1 · default
1limitnumberrequired1–100 · default
20searchstringoptionalfiltersobjectoptionaltypeenum[]optionalstatusenum[]optionalindustrystring[]optionaltagsstring[]optionalhasCreditbooleanoptionalcreditRiskenumoptional"LOW" "MEDIUM" "HIGH"sortByenumrequired"name" "createdAt" "updatedAt" "creditScore" "totalRevenue" · default "name"sortOrderenumrequired"asc" "desc" · default "asc"includeContactsbooleanrequireddefault
falseincludeFinancialsbooleanrequireddefault
falseResponse
200 Success. The result is in
result.data.json : objecttiersobject[]optionalidstringoptionalnamestringoptionalupdatedAtstringoptionalcreatedAtstringoptionalsyncedAtstringoptionalsuperiorIdanyoptionalrefstringoptionalexternalIdstringoptionalexternalRefstringoptionalexternalRefComptableanyoptionaldescriptionstringoptionalnumSirenanyoptionalnumSiretanyoptionalnumTvaanyoptionalcodeNafanyoptionalcommercialanyoptionalstatutstringoptionalsourcestringoptionalecheanceanyoptionalmodeDePaiementanyoptionalmainActivityanyoptionalpaymentConditionIdanyoptionaldeliveryCommentsanyoptionaldate_creationstringoptionaldate_dernier_appelTeleproanyoptionaldate_dernier_appelCommercialanyoptionaldate_dernier_rdvanyoptionaldate_prochain_rdvanyoptionalrdvPrisanyoptionalribanyoptionalextraDataobjectoptionalemailstringoptionaloptinbooleanoptionalactivebooleanoptionalid_langintegeroptionalid_shopintegeroptionaldate_addstringoptionaldate_updstringoptionallastSyncstringoptionallastnamestringoptionaladdressesany[]optionalfirstnamestringoptionalnewsletterbooleanoptionalid_customerintegeroptionalid_shop_groupintegeroptionalgeocodeanyoptionaladdressL1anyoptionaladdressL2anyoptionaladdressCPanyoptionaladdressCommuneanyoptionaladdressDepartementanyoptionallatitudeanyoptionallongitudeanyoptionaluserIdstringoptionalcreatedByIdstringoptionalassignedToIdanyoptionaltenantIdstringoptionalsiteIdstringoptionallastSyncedAtanyoptionalaccountManagerIdanyoptionalannualRevenueanyoptionalaverageOrderValuestringoptionalcompanySizeanyoptionalcreditCheckDateanyoptionalcreditLimitanyoptionalcreditScoreanyoptionalcreditUsedstringoptionalfirstOrderDateanyoptionalindustryanyoptionallanguagestringoptionallastOrderDateanyoptionallastQualificationDateanyoptionalleadScoreintegeroptionallifetimeValuestringoptionaloutstandingBalancestringoptionalparentCompanyIdanyoptionalpartnerTypeanyoptionalpaymentTermsanyoptionalpreferredContactMethodstringoptionalpreferredCurrencystringoptionalqualificationNotesanyoptionalqualificationStatusanyoptionalsocialMediaUrlsanyoptionaltaxExemptbooleanoptionaltimezoneanyoptionaltotalRevenuestringoptionalwebsiteanyoptionalcontactsany[]optionalfinancialany[]optionaltotalintegeroptionalpageintegeroptionallimitintegeroptionalhasMorebooleanoptionalsummaryanyoptionalTry it
POST/api/trpc/tiers.linkContactLink Contact
Input
tiersIdstring · uuidrequiredcontactIdstring · uuidrequiredrolestringoptionalisPrimarybooleanrequireddefault
falseResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
GET/api/trpc/tiers.searchAndExportTiersSearch And Export Tiers
Input
searchstringoptionalfiltersobjectoptionaltypeenum[]optionalstatusenum[]optionalindustrystring[]optionaltagsstring[]optionalcreditScoreMinnumberoptionalcreditScoreMaxnumberoptionalcreatedFromanyoptionalcreatedToanyoptionalsortByenumrequired"name" "createdAt" "updatedAt" "creditScore" · default "name"sortOrderenumrequired"asc" "desc" · default "asc"pagenumberrequired≥ 1 · default
1limitnumberrequired1–1000 · default
50exportbooleanrequireddefault
falseexportFormatenumrequired"CSV" "EXCEL" · default "CSV"Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/tiers.toggleTiersStatusToggle Tiers Status
Input
idstring · uuidrequiredstatusenumrequired"ACTIVE" "INACTIVE" "ARCHIVED"Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/tiers.unlinkContactUnlink Contact
Input
tiersIdstring · uuidrequiredcontactIdstring · uuidrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/tiers.updateActivityUpdate Activity
Input
tiersIdstring · uuidoptionaltypeenumoptional"CALL" "EMAIL" "MEETING" "TASK" "NOTE" "DOCUMENT_SHARED" "QUOTE_SENT" "PROPOSAL_SENT" "CONTRACT_SIGNED" "PAYMENT_RECEIVED" …subjectstringoptional≥ 1 chars
descriptionstringoptionalscheduledAtanyoptionalcontactIdstring · uuidoptionalopportunityIdstring · uuidoptionaleventIdstring · uuidoptionalpriorityenumoptional"LOW" "MEDIUM" "HIGH" "URGENT" · default "MEDIUM"metadataobjectoptionalidstring · uuidoptionalstatusenumoptional"PENDING" "COMPLETED" "CANCELLED"outcomestringoptionalnotesstringoptionalcompletedAtanyoptionaldurationnumberoptional≥ > 0
Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/tiers.updateFinancialInfoUpdate Financial Info
Input
tiersIdstring · uuidrequiredfinancialDataobjectrequiredtotalRevenuenumberoptional≥ 0
outstandingBalancenumberoptional≥ 0
averageOrderValuenumberoptional≥ 0
lifetimeValuenumberoptional≥ 0
creditLimitnumberoptional≥ 0
creditUsednumberoptional≥ 0
paymentTermsstringoptionalcreditScorenumberoptional0–1000
riskLevelenumoptional"LOW" "MEDIUM" "HIGH"lastPaymentDateanyoptionalfirstOrderDateanyoptionallastOrderDateanyoptionalpaymentConditionanyoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
POST/api/trpc/tiers.updateOpportunityUpdate Opportunity
Input
tiersIdstring · uuidoptionalnamestringoptional≥ 1 chars
descriptionstringoptionalstatusenumoptional"LEAD" "QUALIFIED" "PROPOSAL" "NEGOTIATION" "CLOSED_WON" "CLOSED_LOST"sourceenumoptional"WEBSITE" "REFERRAL" "COLD_CALL" "EMAIL_CAMPAIGN" "SOCIAL_MEDIA" "TRADE_SHOW" "PARTNER" "OTHER"stagestringoptionalvaluenumberoptional≥ > 0
probabilitynumberoptional0–100 · default
0expectedCloseDateanyoptionalprimaryContactIdstring · uuidoptionalassignedToIdstring · uuidoptionallostReasonstringoptionalcompetitorInfostringoptionalnextActionstringoptionalnextActionDateanyoptionalmetadataobjectoptionalidstring · uuidoptionalactualCloseDateanyoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/tiers.updateTiersUpdate Tiers
Input
idstring · uuidrequiredupdatesobjectrequirednamestringoptional≥ 1 chars
emailstring · emailoptionalphonestringoptionalsiretstringoptionalsirenstringoptionaltvastringoptionaltypeenumoptional"CLIENT" "FOURNISSEUR" "PROSPECT" "PARTENAIRE"statusenumoptional"ACTIVE" "INACTIVE" "ARCHIVED"industrystringoptionalcompanySizestringoptionalannualRevenuestringoptionalwebsitestring · urioptionaldescriptionstringoptionalcreditLimitnumberoptional≥ 0
creditUsednumberoptional≥ 0
paymentTermsstringoptionalpreferredCurrencyenumoptional"EUR" "USD" "GBP"taxExemptbooleanoptionalcreditScorenumberoptional0–1000
riskLevelenumoptional"LOW" "MEDIUM" "HIGH"tagsstring[]optionalmetadataobjectoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
users 20
GET/api/trpc/users.checkUserSiteAccessCheck User Site Access
Input
siteIdstringrequiredResponse
200 Success. The result is in
result.data.json : objecthasAccessbooleanoptionaluserSiteIdstringoptionalrequestedSiteIdstringoptionalisSuperAdminbooleanoptionalTry it
POST/api/trpc/users.createUserForSiteCreate User For Site
Input
firstNamestringrequired≥ 1 chars
lastNamestringrequired≥ 1 chars
emailstring · emailrequiredrolesstring[]requiredphonestringoptionaltitlestringoptionaltenantIdstringoptionalsiteIdstringrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/users.createUserCreate User
Input
firstNamestringrequired≥ 1 chars
lastNamestringrequired≥ 1 chars
emailstring · emailrequiredrolesstring[]requiredphonestringoptionaltitlestringoptionaltenantIdstringoptionalsiteIdstringoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/users.deleteUserDelete User
Input
userIdstringrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/users.deleteUsersDelete Users
Input
userIdsstring[]requiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/users.forgotPasswordForgot Password
Input
emailstring · emailrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/users.getAnonymousMeilisearchCredentialsGet Anonymous Meilisearch Credentials
Input
No input.
Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/users.getAuthoredArticlesGet Authored Articles
Input
userIdstring · uuidrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
Example with required fields only. Replace the all-zero IDs with real values.
GET/api/trpc/users.getServerUsersGet Server Users
Input
tenantIdstringoptionalsiteIdstringoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/users.getUserDetailsGet User Details
Input
userIdstringrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/users.getUserGet User
Input
idstringrequiredResponse
200 Success. The result is in
result.data.json : objectidstringoptionalupdatedAtstringoptionalcreatedAtstringoptionalemailVerifiedstringoptionalblockedbooleanoptionalnamestringoptionalemailstringoptionalfirstNameanyoptionallastNameanyoptionaltitleanyoptionalpasswordstringoptionalphoneanyoptionalimageanyoptionaldataobjectoptionalmenuAllowliststring[]optionalresetTokenanyoptionalresetTokenExpiryanyoptionalemailVerificationTokenanyoptionalemailVerificationTokenExpiryanyoptionalsuperiorIdanyoptionalsiteIdstringoptionaltenantIdstringoptionalcanAccessReportsbooleanoptionalcanManageCashbooleanoptionalcanSupervisorOverridebooleanoptionalcanVoidTransactionsbooleanoptionalcurrentShiftStartanyoptionalemployeeNumberanyoptionalisClockedInbooleanoptionalmaxDiscountPercentintegeroptionalposPermissionsanyoptionalposPinanyoptionalposRolestringoptionalTry it
GET/api/trpc/users.getUserProfileGet User Profile
Input
userIdstringrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/users.getUserRolesGet User Roles
Input
userIdstringrequiredResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
GET/api/trpc/users.getUsersGet Users
Input
pagenumberrequireddefault
0per_pagenumberrequireddefault
10searchstringoptionalsortstringoptionaladvancedSortsobject[]optionalfieldstringrequireddirectionenumrequired"asc" "desc"advancedFiltersobjectoptionalfiltersobjectoptionalhidden_columnsstring[]optionaltenantIdstringoptionalsiteIdstringoptionalResponse
200 Success. The result is in
result.data.json : objectdataobject[]optionalidstringoptionalupdatedAtstringoptionalcreatedAtstringoptionalemailVerifiedstringoptionalblockedbooleanoptionalnamestringoptionalemailstringoptionalfirstNamestringoptionallastNamestringoptionaltitleanyoptionalpasswordstringoptionalphoneanyoptionalimageanyoptionaldataobjectoptionalmenuAllowliststring[]optionalresetTokenanyoptionalresetTokenExpiryanyoptionalemailVerificationTokenanyoptionalemailVerificationTokenExpiryanyoptionalsuperiorIdanyoptionalsiteIdstringoptionaltenantIdstringoptionalcanAccessReportsbooleanoptionalcanManageCashbooleanoptionalcanSupervisorOverridebooleanoptionalcanVoidTransactionsbooleanoptionalcurrentShiftStartanyoptionalemployeeNumberanyoptionalisClockedInbooleanoptionalmaxDiscountPercentintegeroptionalposPermissionsanyoptionalposPinanyoptionalposRolestringoptionaltenantobjectoptionalnamestringoptionalcodestringoptionalstatusstringoptionalsiteobjectoptionalnamestringoptionalslugstringoptionalstatusstringoptionalrolesobject[]optionalnamestringoptionallabelstringoptionalfullNamestringoptionalroleNamesstringoptionalstatusstringoptionalisAdminbooleanoptionalprimaryRolestringoptionalpaginationobjectoptionalpageintegeroptionalper_pageintegeroptionaltotalintegeroptionaltotal_pagesintegeroptionalTry it
GET/api/trpc/users.listList
Input
searchstringoptionallimitnumberrequireddefault
50tenantIdstringoptionalsiteIdstringoptionalonlyAuthorsbooleanoptionalResponse
200 Success. The result is in
result.data.json : object[]idstringoptionalnamestringoptionalemailstringoptionalimageanyoptionalTry it
GET/api/trpc/users.listMyUsersList My Users
Input
pagenumberrequireddefault
0per_pagenumberrequireddefault
10searchstringoptionalsortstringoptionaladvancedSortsobject[]optionalfieldstringrequireddirectionenumrequired"asc" "desc"advancedFiltersobjectoptionalfiltersobjectoptionalhidden_columnsstring[]optionalResponse
200 Success. The result is in
result.data.json : objectdataobject[]optionalidstringoptionalupdatedAtstringoptionalcreatedAtstringoptionalemailVerifiedstringoptionalblockedbooleanoptionalnamestringoptionalemailstringoptionalfirstNamestringoptionallastNamestringoptionaltitleanyoptionalpasswordstringoptionalphoneanyoptionalimageanyoptionaldataobjectoptionalmenuAllowliststring[]optionalresetTokenanyoptionalresetTokenExpiryanyoptionalemailVerificationTokenanyoptionalemailVerificationTokenExpiryanyoptionalsuperiorIdanyoptionalsiteIdstringoptionaltenantIdstringoptionalcanAccessReportsbooleanoptionalcanManageCashbooleanoptionalcanSupervisorOverridebooleanoptionalcanVoidTransactionsbooleanoptionalcurrentShiftStartanyoptionalemployeeNumberanyoptionalisClockedInbooleanoptionalmaxDiscountPercentintegeroptionalposPermissionsanyoptionalposPinanyoptionalposRolestringoptionaltenantobjectoptionalnamestringoptionalcodestringoptionalstatusstringoptionalsiteobjectoptionalnamestringoptionalslugstringoptionalstatusstringoptionalrolesobject[]optionalnamestringoptionallabelstringoptionalfullNamestringoptionalroleNamesstringoptionalstatusstringoptionalisAdminbooleanoptionalprimaryRolestringoptionalpaginationobjectoptionalpageintegeroptionalper_pageintegeroptionaltotalintegeroptionaltotal_pagesintegeroptionalTry it
POST/api/trpc/users.resetPasswordWithTokenReset Password With Token
Input
tokenstringrequired≥ 1 chars
passwordstringrequired≥ 8 chars
Response
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/users.sendPasswordResetEmailSend Password Reset Email
Input
emailstring · emailrequiredtenantIdstring · uuidoptionalsiteIdstring · uuidoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/users.updateUserUpdate User
Input
idstringrequirednamestringoptionalfirstNamestringoptionallastNamestringoptionalemailstring · emailoptionaltitlestringoptionalphonestringoptionalimagestringoptionalblockedbooleanoptionalemailVerifiedanyoptionalroleIdsstring[]optionaldataobjectoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it
POST/api/trpc/users.updateUserProfileUpdate User Profile
Input
firstNamestringrequiredlastNamestringrequiredphonestringoptionalemailstring · emailrequiredcompanyNamestringoptionaladdressstringoptionalbiostringoptionaltwitterUrlstringoptionallinkedinUrlstringoptionalwebsitestringoptionaluserIdstringoptionalResponse
200 Success. The result is in
result.data.jsonThe result format is not documented for this procedure yet.
Try it