Explorateur d'API
Toutes les procédures de l'API de la plateforme Inklura, groupées par router. Chaque fiche donne la méthode, l'entrée attendue et la réponse. Avec vos identifiants, vous pouvez copier un cURL prêt à lancer ou envoyer la requête depuis cette page.
Note
Chaque opération est une procédure tRPC appelée sur /api/trpc/<router>.<procedure> : les mutations en POST (corps {"json": <entrée>}), les requêtes en GET (?input= suivi du même objet encodé). L'entrée affichée est ce contenu json ; les réponses arrivent dans {"result":{"data":{"json": …}}}. Les requêtes s'authentifient avec un JWT Bearer. Voir le guide tRPC.
Serveur: https://manage.inklura.fr · 307 opérations · Télécharger la spécification OpenAPI complète
Identifiants & contexteRestent dans votre navigateur. Le token est oublié à la fermeture de l'onglet, sauf si vous cochez « Se souvenir ».
Ouvre la console Inklura : connectez-vous comme d'habitude (mot de passe, lien d'invitation, SSO), puis autorisez l'explorateur. Le token revient directement ici.
Ou collez un token existant
Aucune opération ne correspond à ce filtre.
auth 12
POST/api/trpc/auth.bridgeOidcBridge Oidc
Entrée
substringrequis≥ 1 car.
emailstring · emailrequisfirstNamestring | nullfacultatiflastNamestring | nullfacultatifnamestring | nullfacultatifRéponse
200 Succès. Le résultat est dans
result.data.json : objectuserIdstringrequisemailstringrequisfirstNamestringrequislastNamestringrequisnamestringrequisroleenumrequis"particulier" "pro"proStatusenumfacultatif"pending" "active" "refused"tenantIdstringrequissiteIdstringrequisEssayer
GET/api/trpc/auth.canAccessManageCan Access Manage
Entrée
Aucune entrée.
Réponse
200 Succès. Le résultat est dans
result.data.json : objectallowedbooleanrequisEssayer
GET/api/trpc/auth.getProfileGet Profile
Entrée
Aucune entrée.
Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/auth.getSecretMessageGet Secret Message
Entrée
Aucune entrée.
Réponse
200 Succès. Le résultat est dans
result.data.json : stringEssayer
GET/api/trpc/auth.getSessionGet Session
Entrée
Aucune entrée.
Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/auth.getUserInfoGet User Info
Entrée
emailstringrequisRéponse
200 Succès. Le résultat est dans
result.data.json : objectinputstringrequisokbooleanrequisuseranyrequisEssayer
POST/api/trpc/auth.loginLogin
Entrée
emailstring · emailrequispasswordstringrequis≥ 1 car.
sitestringfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/auth.registerRegister
Entrée
emailstring · emailrequispasswordstringrequis≥ 8 car.
confirmPasswordstringrequis≥ 1 car.
firstNamestringrequis≥ 2 car.
lastNamestringrequis≥ 2 car.
isArchitectbooleanfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/auth.requestPasswordResetRequest Password Reset
Entrée
emailstring · emailrequisRéponse
200 Succès. Le résultat est dans
result.data.json : objectsuccessbooleanrequismessagestringrequisEssayer
POST/api/trpc/auth.resendVerificationEmailResend Verification Email
Entrée
Aucune entrée.
Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/auth.signupSignup
Entrée
emailstring · emailrequispasswordstringrequis≥ 8 car.
firstNamestringrequis≥ 1 car.
lastNamestringrequis≥ 1 car.
Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/auth.verifyEmailVerify Email
Entrée
tokenstringrequis≥ 32 car.
Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
campaigns 14
POST/api/trpc/campaigns.createCampaignCreate Campaign
Entrée
namestringrequis≥ 3 car.
typestringrequissubjectstringfacultatifcontentstringfacultatifscheduledbooleanrequispar défaut
falsescheduledDateanyfacultatiftestModebooleanrequispar défaut
falsetestEmailstring · emailfacultatiftemplateIdstringfacultatifsegmentIdstringfacultatifmarketingCampaignIdstringfacultatifchannelTypestringfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/campaigns.createCampaignTagCreate Campaign Tag
Entrée
namestringrequis≥ 1 car.
Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/campaigns.createCampaignWizardCreate Campaign Wizard
Entrée
channelTypeobjectrequischannelTypestringrequis≥ 1 car.
campaignobjectfacultatifmarketingCampaignIdstringfacultatifdetailsobjectrequisnamestringrequistypeIdstringfacultatifstatusenumrequis"draft" "scheduled" "active" "completed" "cancelled"startDateanyrequisendDateanyfacultatifdescriptionstringfacultatiftemplateobjectrequistemplateIdstringfacultatifsubjectstringrequiscontentstringrequismjmlstringrequispreviewTextstringfacultatifdataSchemaobjectfacultatifaudienceobjectrequissegmentsstring[]requisfiltersobjectfacultatifexcludedSegmentsstring[]facultatifscheduleobjectrequissendTimeenumrequis"immediate" "scheduled"scheduledDateanyfacultatiftimezonestringrequisthrottlingobjectfacultatifenabledbooleanrequisratenumberfacultatifintervalenumfacultatif"minute" "hour"Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/campaigns.deleteCampaignDelete Campaign
Entrée
idstringrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/campaigns.duplicateCampaignDuplicate Campaign
Entrée
idstringrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/campaigns.getCampaignActivityGet Campaign Activity
Entrée
idstringrequispagenumberrequispar défaut
0per_pagenumberrequispar défaut
10Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/campaigns.getCampaignByIdGet Campaign By Id
Entrée
idstringrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/campaigns.getCampaignsGet Campaigns
Entrée
pagenumberrequispar défaut
0per_pagenumberrequispar défaut
10searchstringrequispar défaut
""statusstringfacultatifRéponse
200 Succès. Le résultat est dans
result.data.json : objectdataany[]facultatiftotalintegerfacultatifpageintegerfacultatifper_pageintegerfacultatiftotalPagesintegerfacultatifEssayer
GET/api/trpc/campaigns.getCampaignTagsGet Campaign Tags
Entrée
Aucune entrée.
Réponse
200 Succès. Le résultat est dans
result.data.json : object[]idstringfacultatifnamestringfacultatifdescriptionanyfacultatiftenantIdstringfacultatifsiteIdstringfacultatifEssayer
POST/api/trpc/campaigns.pauseCampaignPause Campaign
Entrée
idstringrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/campaigns.resumeCampaignResume Campaign
Entrée
idstringrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/campaigns.sendCampaignSend Campaign
Entrée
idstringrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/campaigns.simulateActivitySimulate Activity
Entrée
idstringrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/campaigns.updateCampaignUpdate Campaign
Entrée
namestringrequis≥ 3 car.
typestringrequissubjectstringfacultatifcontentstringfacultatifscheduledbooleanrequispar défaut
falsescheduledDateanyfacultatiftestModebooleanrequispar défaut
falsetestEmailstring · emailfacultatiftemplateIdstringfacultatifsegmentIdstringfacultatifmarketingCampaignIdstringfacultatifchannelTypestringfacultatifidstringrequisstatusenumfacultatif"draft" "scheduled" "active" "paused" "completed" "error"Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
clients 18
POST/api/trpc/clients.approveProApprove Pro
Entrée
clientIdstring · uuidrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/clients.createCreate
Entrée
namestringrequis≥ 1 car.
emailstring · emailfacultatifphonestringfacultatifaddressstringfacultatifzipCodestringfacultatifcitystringfacultatifcountrystringfacultatifsiretstringfacultatifcodeNafstringfacultatiftypeIdstringfacultatifarchivedbooleanrequispar défaut
falseisMainRecordbooleanrequispar défaut
trueisProfessionalbooleanrequispar défaut
falseexternalIdstringfacultatifmainRecordIdstringfacultatiftiersIdstring | nullfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/clients.deleteAllClientsDelete All Clients
Entrée
confirmationIdstringrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/clients.deleteClientDelete Client
Entrée
idstringrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/clients.deleteClientsDelete Clients
Entrée
idsstring[]requisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/clients.getClientByIdGet Client By Id
Entrée
idstringrequisRéponse
200 Succès. Le résultat est dans
result.data.json : objectidstringfacultatifnamestringfacultatifaddressanyfacultatifzipCodeanyfacultatifcityanyfacultatifcountryanyfacultatifemailstringfacultatifphoneanyfacultatifsiretanyfacultatifcodeNafanyfacultatifcustomInputsobjectfacultatiflastNamestringfacultatiffirstNamestringfacultatiflastUpdatedstringfacultatifprestashop_idstringfacultatifexternalIdanyfacultatifarchivedbooleanfacultatifisProfessionalbooleanfacultatiftenantIdstringfacultatifsiteIdstringfacultatifcreatedAtstringfacultatifupdatedAtstringfacultatifisMainRecordbooleanfacultatifmainRecordIdanyfacultatiftypeIdanyfacultatiftiersIdanyfacultatifterritoryIdanyfacultatifdataanyfacultatiftypeanyfacultatifTiersanyfacultatifsentInvoicesany[]facultatifreceivedInvoicesany[]facultatifreceivedOrdersobject[]facultatifidstringfacultatifinvoiceNumberstringfacultatifinvoiceStatusstringfacultatiftotalAmountnumberfacultatifcreatedAtstringfacultatifinvoiceDatestringfacultatifdeliveryDatestringfacultatifEssayer
GET/api/trpc/clients.getClientContactsGet Client Contacts
Entrée
clientIdstringrequispagenumberrequispar défaut
1per_pagenumberrequispar défaut
10searchstringfacultatifsortstringfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/clients.getClientsByTiersGet Clients By Tiers
Entrée
tiersIdstringrequispagenumberrequispar défaut
1per_pagenumberrequispar défaut
20searchstringfacultatifsortstringfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/clients.getClientsGet Clients
Entrée
pagenumberrequispar défaut
1per_pagenumberrequispar défaut
20sortstringfacultatifsearchstring | nullfacultatifcursornumber | nullfacultatiffiltersobjectfacultatifadvancedFiltersany[]facultatifadvancedSortsobject[]facultatiffieldstringrequisdirectionenumrequis"asc" "desc"Réponse
200 Succès. Le résultat est dans
result.data.json : objectdataobject[]facultatifidstringfacultatifnamestringfacultatifemailstringfacultatifphoneanyfacultatifaddressanyfacultatifzipCodeanyfacultatifcityanyfacultatifcountryanyfacultatifsiretanyfacultatifcodeNafanyfacultatifarchivedbooleanfacultatifcreatedAtstringfacultatifupdatedAtstringfacultatifisMainRecordbooleanfacultatifisProfessionalbooleanfacultatifexternalIdanyfacultatifmainRecordIdanyfacultatiftypeIdanyfacultatiftiersIdanyfacultatifcustomInputsobjectfacultatiflastNamestringfacultatiffirstNamestringfacultatiflastUpdatedstringfacultatifprestashop_idstringfacultatiftypeanyfacultatifTiersanyfacultatifsentInvoicesany[]facultatifreceivedInvoicesany[]facultatifreceivedOrdersobject[]facultatifidstringfacultatifinvoiceNumberstringfacultatifinvoiceStatusstringfacultatiftotalAmountnumberfacultatifcreatedAtstringfacultatifinvoiceDatestringfacultatifdeliveryDatestringfacultatiftotalintegerfacultatifpageCountintegerfacultatifcolumnsobjectfacultatifnameobjectfacultatiftypestringfacultatiflabelstringfacultatifrequiredbooleanfacultatifsortablebooleanfacultatiffilterablebooleanfacultatiftypeobjectfacultatiftypestringfacultatiflabelstringfacultatifrequiredbooleanfacultatifsortablebooleanfacultatiffilterablebooleanfacultatifrelationTablestringfacultatifrelationLabelFieldstringfacultatifrelationColorFieldstringfacultatifrelationIconFieldstringfacultatifemailobjectfacultatiftypestringfacultatiflabelstringfacultatifrequiredbooleanfacultatifsortablebooleanfacultatiffilterablebooleanfacultatifphoneobjectfacultatiftypestringfacultatiflabelstringfacultatifrequiredbooleanfacultatifsortablebooleanfacultatiffilterablebooleanfacultatifaddressobjectfacultatiftypestringfacultatiflabelstringfacultatifrequiredbooleanfacultatifsortablebooleanfacultatiffilterablebooleanfacultatifzipCodeobjectfacultatiftypestringfacultatiflabelstringfacultatifrequiredbooleanfacultatifsortablebooleanfacultatiffilterablebooleanfacultatifcityobjectfacultatiftypestringfacultatiflabelstringfacultatifrequiredbooleanfacultatifsortablebooleanfacultatiffilterablebooleanfacultatifcountryobjectfacultatiftypestringfacultatiflabelstringfacultatifrequiredbooleanfacultatifsortablebooleanfacultatiffilterablebooleanfacultatifsiretobjectfacultatiftypestringfacultatiflabelstringfacultatifrequiredbooleanfacultatifsortablebooleanfacultatiffilterablebooleanfacultatifcodeNafobjectfacultatiftypestringfacultatiflabelstringfacultatifrequiredbooleanfacultatifsortablebooleanfacultatiffilterablebooleanfacultatifarchivedobjectfacultatiftypestringfacultatiflabelstringfacultatifrequiredbooleanfacultatifsortablebooleanfacultatiffilterablebooleanfacultatifoptionsobject[]facultatiflabelstringfacultatifvaluestringfacultatifisProfessionalobjectfacultatiftypestringfacultatiflabelstringfacultatifrequiredbooleanfacultatifsortablebooleanfacultatiffilterablebooleanfacultatifoptionsobject[]facultatiflabelstringfacultatifvaluestringfacultatifisMainRecordobjectfacultatiftypestringfacultatiflabelstringfacultatifrequiredbooleanfacultatifsortablebooleanfacultatiffilterablebooleanfacultatifoptionsobject[]facultatiflabelstringfacultatifvaluestringfacultatifcreatedAtobjectfacultatiftypestringfacultatiflabelstringfacultatifrequiredbooleanfacultatifsortablebooleanfacultatiffilterablebooleanfacultatifupdatedAtobjectfacultatiftypestringfacultatiflabelstringfacultatifrequiredbooleanfacultatifsortablebooleanfacultatiffilterablebooleanfacultatifnextCursorintegerfacultatifEssayer
POST/api/trpc/clients.linkContactLink Contact
Entrée
clientIdstringrequiscontactIdstringrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/clients.listPendingProList Pending Pro
Entrée
pagenumberrequis≥ 1 · par défaut
1perPagenumberrequis1–100 · par défaut
20Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/clients.refuseProRefuse Pro
Entrée
clientIdstring · uuidrequisreasonstringrequis3–2000 car.
Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/clients.requestProSignupRequest Pro Signup
Entrée
companyNamestringrequis≥ 1 car.
siretstringrequiscodeNafstring | nullfacultatifaddressstringrequis≥ 1 car.
zipCodestringrequis≥ 1 car.
citystringrequis≥ 1 car.
firstNamestringrequis≥ 1 car.
lastNamestringrequis≥ 1 car.
rolestring | nullfacultatifphonestringrequis≥ 1 car.
emailstring · emailrequispasswordstringrequis≥ 8 car.
filierestringrequis≥ 1 car.
volumeEstimatestring | nullfacultatifmessagestring | nullfacultatifnewsletterbooleanrequispar défaut
falseRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/clients.searchContactsToLinkSearch Contacts To Link
Entrée
searchstringfacultatifpagenumberrequispar défaut
1per_pagenumberrequispar défaut
10Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/clients.syncClientsSync Clients
Entrée
offsetnumberrequislimitnumberrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/clients.unlinkContactUnlink Contact
Entrée
clientIdstringrequiscontactIdstringrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/clients.unlinkTiersUnlink Tiers
Entrée
idstringrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/clients.updateClientUpdate Client
Entrée
idstringrequisnamestringfacultatif≥ 1 car.
emailstring · emailfacultatifphonestringfacultatifaddressstringfacultatifzipCodestringfacultatifcitystringfacultatifcountrystringfacultatifsiretstringfacultatifcodeNafstringfacultatiftypeIdstringfacultatifarchivedbooleanfacultatifisMainRecordbooleanfacultatifisProfessionalbooleanfacultatifexternalIdstringfacultatifmainRecordIdstringfacultatiftiersIdstring | nullfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
coupons 6
POST/api/trpc/coupons.createCreate
Entrée
codestringrequis1–64 car.
typeenumrequis"PERCENT" "FLAT"valueintegerrequis0–9007199254740991
appliesToPlanIdsstring · uuid[]requispar défaut
[]appliesToCountryenum | nullfacultatifappliesToDurationYearsinteger | nullfacultatifvalidFromany | nullfacultatifvalidToany | nullfacultatifmaxRedemptionsinteger | nullfacultatifdescriptionstring | nullfacultatifactivebooleanrequispar défaut
trueRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/coupons.deleteDelete
Entrée
idstring · uuidrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
GET/api/trpc/coupons.getGet
Entrée
idstring · uuidrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
GET/api/trpc/coupons.listList
Entrée
activeOnlybooleanrequispar défaut
falseRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/coupons.updateUpdate
Entrée
codestringfacultatif1–64 car.
typeenumfacultatif"PERCENT" "FLAT"valueintegerfacultatif0–9007199254740991
appliesToPlanIdsstring · uuid[]facultatifappliesToCountryenum | nullfacultatifappliesToDurationYearsinteger | nullfacultatifvalidFromany | nullfacultatifvalidToany | nullfacultatifmaxRedemptionsinteger | nullfacultatifdescriptionstring | nullfacultatifactivebooleanfacultatifidstring · uuidrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
GET/api/trpc/coupons.validateValidate
Entrée
codestringrequis1–64 car.
countryenumrequis"FR" "WORLD" · par défaut "FR"itemsobject[]requispar défaut
[]planIdstringrequiskindenumrequis"subscription" "magazine" · par défaut "magazine"durationYearsintegerfacultatif1–2
lineTotalnumberrequis≥ 0
Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
helpdeskKb 10
POST/api/trpc/helpdeskKb.createArticleCreate Article
Entrée
titlestringrequis≥ 1 car.
slugstringfacultatifexcerptstringfacultatifbodystringfacultatifstatusstringfacultatifvisibilitystringfacultatifcategoryIdstring | nullfacultatiftagsstring[]facultatifseoTitlestringfacultatifseoDescriptionstringfacultatifordernumberfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/helpdeskKb.createCategoryCreate Category
Entrée
namestringrequis≥ 1 car.
slugstringfacultatifdescriptionstringfacultatificonstringfacultatifparentIdstring | nullfacultatifordernumberfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/helpdeskKb.deleteArticleDelete Article
Entrée
idstringrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/helpdeskKb.deleteCategoryDelete Category
Entrée
idstringrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/helpdeskKb.getArticleByIdGet Article By Id
Entrée
idstringrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/helpdeskKb.getArticlesGet Articles
Entrée
searchstringfacultatifstatusstringfacultatifvisibilitystringfacultatifcategoryIdstringfacultatifincludeArchivedbooleanrequispar défaut
falseRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/helpdeskKb.getCategoriesGet Categories
Entrée
Aucune entrée.
Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/helpdeskKb.getCategoryByIdGet Category By Id
Entrée
idstringrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/helpdeskKb.updateArticleUpdate Article
Entrée
titlestringfacultatif≥ 1 car.
slugstringfacultatifexcerptstringfacultatifbodystringfacultatifstatusstringfacultatifvisibilitystringfacultatifcategoryIdstring | nullfacultatiftagsstring[]facultatifseoTitlestringfacultatifseoDescriptionstringfacultatifordernumberfacultatifidstringrequisarchivedbooleanfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/helpdeskKb.updateCategoryUpdate Category
Entrée
namestringfacultatif≥ 1 car.
slugstringfacultatifdescriptionstringfacultatificonstringfacultatifparentIdstring | nullfacultatifordernumberfacultatifidstringrequisarchivedbooleanfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
invoices 26
POST/api/trpc/invoices.convertQuoteConvert Quote
Entrée
idstringrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/invoices.createCreditNoteCreate Credit Note
Entrée
idstringrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/invoices.createDraftCreate Draft
Entrée
receiverIdstringrequisinvoiceTypeenumfacultatif"INVOICE" "QUOTE" "PURCHASE_ORDER"invoiceDatestringfacultatifdueDatestringfacultatifnotesstringfacultatifcurrencystringfacultatiftemplateIdintegerfacultatif1–5
itemsobject[]requisnamestringrequisquantitynumberrequisunitPricenumberrequistaxRatenumberrequispar défaut
20productIdstringfacultatifproductSkustringfacultatifdiscountobjectfacultatiftypeenumrequis"PERCENT" "FIXED"valuenumberrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/invoices.createInvoiceCreate Invoice
Entrée
numberstringrequisclientIdstringrequistotalnumberrequisitemsobject[]requisdescriptionstringrequisquantitynumberrequisunitPricenumberrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/invoices.createStripeConnectAccountCreate Stripe Connect Account
Entrée
refreshUrlstring · urirequisreturnUrlstring · urirequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/invoices.createStripeConnectLinkCreate Stripe Connect Link
Entrée
refreshUrlstring · urirequisreturnUrlstring · urirequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/invoices.deleteAllInvoicesDelete All Invoices
Entrée
confirmationIdstringrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/invoices.deleteInvoiceDelete Invoice
Entrée
idstringrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/invoices.deleteIssuerProfileDelete Issuer Profile
Entrée
scopeobjectrequislevelenumrequis"tenant" "site" "domain" · par défaut "site"domainIdstringfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/invoices.disconnectStripeDisconnect Stripe
Entrée
Aucune entrée.
Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/invoices.getClientsForSelectGet Clients For Select
Entrée
Aucune entrée.
Réponse
200 Succès. Le résultat est dans
result.data.json : object[]idstringfacultatifnamestringfacultatifemailstringfacultatifEssayer
GET/api/trpc/invoices.getCrossTenantOverviewGet Cross Tenant Overview
Entrée
Aucune entrée.
Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/invoices.getCrossTenantPaymentStatusGet Cross Tenant Payment Status
Entrée
Aucune entrée.
Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/invoices.getDashboardMetricsGet Dashboard Metrics
Entrée
Aucune entrée.
Réponse
200 Succès. Le résultat est dans
result.data.json : objectmonthlyobject[]facultatiflabelstringfacultatiffactureintegerfacultatifencaisseintegerfacultatifbyStatusany[]facultatifEssayer
GET/api/trpc/invoices.getEffectiveIssuerProfileGet Effective Issuer Profile
Entrée
Aucune entrée.
Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/invoices.getInvoiceGet Invoice
Entrée
idstringrequisRéponse
200 Succès. Le résultat est dans
result.data.json : objectidstringfacultatifsenderIdstringfacultatifreceiverIdstringfacultatifinvoiceLogoanyfacultatifinvoiceNumberstringfacultatifinvoiceDatestringfacultatifinvoiceTypeanyfacultatifinvoiceStatusstringfacultatifdueDateanyfacultatifpurchaseOrderNumberanyfacultatifcurrencystringfacultatiflanguagestringfacultatifpaymentInformationobjectfacultatiftaxDetailsobjectfacultatifdiscountDetailsobjectfacultatifshippingDetailsobjectfacultatifsubTotalanyfacultatiftotalAmountintegerfacultatiftotalAmountInWordsstringfacultatifadditionalNotesanyfacultatifpaymentTermsstringfacultatifpaymentMethodanyfacultatifsignatureobjectfacultatifstartedAtanyfacultatifendedAtanyfacultatiflocationanyfacultatifcreatedAtstringfacultatifupdatedAtstringfacultatifpdfTemplateintegerfacultatifpdfFormatanyfacultatifcustomInputsanyfacultatiffooteranyfacultatifsourceanyfacultatifemplacementIdanyfacultatiftenantIdstringfacultatifuserIdanyfacultatifsiteIdstringfacultatifrecurringInvoiceIdanyfacultatifdomainIdanyfacultatifissuerProfileIdanyfacultatifsequenceKeyanyfacultatifissuedAtanyfacultatiflockedbooleanfacultatifitemsany[]facultatifreceiverobjectfacultatifidstringfacultatifnamestringfacultatifaddressanyfacultatifzipCodeanyfacultatifcityanyfacultatifcountryanyfacultatifemailanyfacultatifphoneanyfacultatifsiretanyfacultatifcodeNafanyfacultatifcustomInputsobjectfacultatifexternalIdanyfacultatifarchivedbooleanfacultatifisProfessionalbooleanfacultatiftenantIdstringfacultatifsiteIdstringfacultatifcreatedAtstringfacultatifupdatedAtstringfacultatifisMainRecordbooleanfacultatifmainRecordIdanyfacultatiftypeIdanyfacultatiftiersIdanyfacultatifterritoryIdanyfacultatifdataanyfacultatifsenderobjectfacultatifidstringfacultatifnamestringfacultatifaddressanyfacultatifzipCodeanyfacultatifcityanyfacultatifcountryanyfacultatifemailanyfacultatifphoneanyfacultatifsiretanyfacultatifcodeNafanyfacultatifcustomInputsobjectfacultatifexternalIdanyfacultatifarchivedbooleanfacultatifisProfessionalbooleanfacultatiftenantIdstringfacultatifsiteIdstringfacultatifcreatedAtstringfacultatifupdatedAtstringfacultatifisMainRecordbooleanfacultatifmainRecordIdanyfacultatiftypeIdanyfacultatiftiersIdanyfacultatifterritoryIdanyfacultatifdataanyfacultatifpdfUrlanyfacultatifEssayer
GET/api/trpc/invoices.getInvoicesGet Invoices
Entrée
limitnumberrequis1–100 · par défaut
50offsetnumberrequis≥ 0 · par défaut
0statusstringfacultatiftypeenumfacultatif"INVOICE" "QUOTE" "CREDIT_NOTE"Réponse
200 Succès. Le résultat est dans
result.data.json : object[]idstringfacultatifsenderIdstringfacultatifreceiverIdstringfacultatifinvoiceLogoanyfacultatifinvoiceNumberstringfacultatifinvoiceDatestringfacultatifinvoiceTypeanyfacultatifinvoiceStatusstringfacultatifdueDateanyfacultatifpurchaseOrderNumberanyfacultatifcurrencystringfacultatiflanguagestringfacultatifpaymentInformationobjectfacultatiftaxDetailsobjectfacultatifdiscountDetailsobjectfacultatifshippingDetailsobjectfacultatifsubTotalanyfacultatiftotalAmountintegerfacultatiftotalAmountInWordsstringfacultatifadditionalNotesanyfacultatifpaymentTermsstringfacultatifpaymentMethodanyfacultatifsignatureobjectfacultatifstartedAtanyfacultatifendedAtanyfacultatiflocationanyfacultatifcreatedAtstringfacultatifupdatedAtstringfacultatifpdfTemplateintegerfacultatifpdfFormatanyfacultatifcustomInputsanyfacultatiffooteranyfacultatifsourceanyfacultatifemplacementIdanyfacultatiftenantIdstringfacultatifuserIdanyfacultatifsiteIdstringfacultatifrecurringInvoiceIdanyfacultatifdomainIdanyfacultatifissuerProfileIdanyfacultatifsequenceKeyanyfacultatifissuedAtanyfacultatiflockedbooleanfacultatifreceiverobjectfacultatifidstringfacultatifnamestringfacultatifaddressanyfacultatifzipCodeanyfacultatifcityanyfacultatifcountryanyfacultatifemailanyfacultatifphoneanyfacultatifsiretanyfacultatifcodeNafanyfacultatifcustomInputsobjectfacultatifexternalIdanyfacultatifarchivedbooleanfacultatifisProfessionalbooleanfacultatiftenantIdstringfacultatifsiteIdstringfacultatifcreatedAtstringfacultatifupdatedAtstringfacultatifisMainRecordbooleanfacultatifmainRecordIdanyfacultatiftypeIdanyfacultatiftiersIdanyfacultatifterritoryIdanyfacultatifdataanyfacultatifpdfUrlanyfacultatifEssayer
GET/api/trpc/invoices.getIssuerProfileGet Issuer Profile
Entrée
scopeobjectfacultatiflevelenumrequis"tenant" "site" "domain" · par défaut "site"domainIdstringfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/invoices.getPaymentSettingsGet Payment Settings
Entrée
Aucune entrée.
Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/invoices.getPublicInvoiceGet Public Invoice
Entrée
tokenstringrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/invoices.listIssuerScopesList Issuer Scopes
Entrée
Aucune entrée.
Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/invoices.saveIssuerProfileSave Issuer Profile
Entrée
scopeobjectfacultatiflevelenumrequis"tenant" "site" "domain" · par défaut "site"domainIdstringfacultatiflegalNamestringrequis≥ 1 car.
emailstringfacultatifphonestringfacultatifsiretstringfacultatifsirenstringfacultatifvatNumberstringfacultatifibanstringfacultatifbicstringfacultatiflogoUrlstringfacultatifcurrencystringfacultatifeditorLayoutenumfacultatif"form" "split" "document" "wizard" "catalog"pdfTemplateintegerfacultatif1–4
invoicePrefixstringfacultatifquotePrefixstringfacultatifcreditNotePrefixstringfacultatiflegalMentionsstringfacultatifaddressobjectfacultatifstreetstringfacultatifcitystringfacultatifpostalCodestringfacultatifcountrystringfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/invoices.savePaymentKeysSave Payment Keys
Entrée
secretKeystringfacultatifpublishableKeystringfacultatifenabledbooleanfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/invoices.searchProductsSearch Products
Entrée
qstringrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/invoices.updateDraftUpdate Draft
Entrée
idstringrequisreceiverIdstringfacultatifinvoiceTypeenumfacultatif"INVOICE" "QUOTE" "PURCHASE_ORDER"invoiceDatestringfacultatifdueDatestringfacultatifnotesstringfacultatifcurrencystringfacultatiftemplateIdintegerfacultatif1–5
itemsobject[]requisnamestringrequisquantitynumberrequisunitPricenumberrequistaxRatenumberrequispar défaut
20productIdstringfacultatifproductSkustringfacultatifdiscountobjectfacultatiftypeenumrequis"PERCENT" "FIXED"valuenumberrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/invoices.updateInvoiceStatusUpdate Invoice Status
Entrée
idstringrequisstatusstringrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
newsletter 18
POST/api/trpc/newsletter.addSubscriberAdd Subscriber
Entrée
emailstringrequisfirstNamestringfacultatiflastNamestringfacultatiftagsstring[]facultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/newsletter.bulkDeleteBulk Delete
Entrée
idsstring · uuid[]requisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/newsletter.bulkUpdateStatusBulk Update Status
Entrée
idsstring · uuid[]requisstatusenumrequis"subscribed" "unsubscribed"Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/newsletter.exportSubscribersExport Subscribers
Entrée
formatenumrequis"csv" "json" · par défaut "csv"subscribedOnlybooleanrequispar défaut
trueRéponse
200 Succès. Le résultat est dans
result.data.json : objectdatastringfacultatifformatstringfacultatifEssayer
GET/api/trpc/newsletter.getAvailableTemplatesGet Available Templates
Entrée
typeenumrequis"welcome" "confirmation" "unsubscribe" "all" · par défaut "all"Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/newsletter.getGrowthDataGet Growth Data
Entrée
daysnumberrequis7–365 · par défaut
90Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/newsletter.getSettingsGet Settings
Entrée
Aucune entrée.
Réponse
200 Succès. Le résultat est dans
result.data.json : objectdoubleOptInbooleanfacultatifconfirmationEmailTemplateIdanyfacultatifconfirmationTokenExpiryintegerfacultatifwelcomeEmailEnabledbooleanfacultatifwelcomeEmailTemplateIdanyfacultatifwelcomeEmailDelayintegerfacultatifunsubscribeConfirmationEnabledbooleanfacultatifunsubscribeConfirmationTemplateIdanyfacultatifadminNotificationEnabledbooleanfacultatifadminNotificationEmailstringfacultatifadminDigestEnabledbooleanfacultatifadminDigestFrequencystringfacultatifdefaultFromNamestringfacultatifdefaultFromEmailstringfacultatifdefaultReplyTostringfacultatifautoArchiveEnabledbooleanfacultatifarchiveVisibilitystringfacultatifbrandColorstringfacultatifheaderLogoUrlstringfacultatiffooterTextstringfacultatifEssayer
GET/api/trpc/newsletter.getStatsGet Stats
Entrée
Aucune entrée.
Réponse
200 Succès. Le résultat est dans
result.data.json : objecttotalintegerfacultatifsubscribedintegerfacultatifunsubscribedintegerfacultatifthisMonthintegerfacultatiflastMonthintegerfacultatifgrowthPercentintegerfacultatifEssayer
GET/api/trpc/newsletter.getSubscriberGet Subscriber
Entrée
idstringrequisRéponse
200 Succès. Le résultat est dans
result.data.json : objectidstringfacultatiffirstNameanyfacultatiflastNameanyfacultatifnamestringfacultatifemailstringfacultatifphoneanyfacultatifmarketingOptInbooleanfacultatifemailOptInbooleanfacultatifsmsOptInbooleanfacultatifsegmentanyfacultatifsourceanyfacultatifcreatedAtstringfacultatiflastActivityanyfacultatifEssayer
GET/api/trpc/newsletter.getSubscriptionStatusGet Subscription Status
Entrée
emailstringrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/newsletter.importSubscribersImport Subscribers
Entrée
subscribersobject[]requisemailstring · emailrequisfirstNamestringfacultatiflastNamestringfacultatifphonestringfacultatifduplicateHandlingenumrequis"update" "skip" · par défaut "update"Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/newsletter.listSubscribersList Subscribers
Entrée
pagenumberrequispar défaut
0limitnumberrequispar défaut
25searchstringfacultatifsubscribedbooleanfacultatifsortByenumrequis"createdAt" "email" "name" · par défaut "createdAt"sortOrderenumrequis"asc" "desc" · par défaut "desc"Réponse
200 Succès. Le résultat est dans
result.data.json : objectitemsobject[]facultatifidstringfacultatiffirstNameanyfacultatiflastNameanyfacultatifnamestringfacultatifemailstringfacultatifmarketingOptInbooleanfacultatifemailOptInbooleanfacultatifsmsOptInbooleanfacultatifsegmentanyfacultatifsourceanyfacultatifsubscribedAtstringfacultatiflastActivityanyfacultatiftotalintegerfacultatifpageintegerfacultatiflimitintegerfacultatifpagesintegerfacultatifEssayer
POST/api/trpc/newsletter.subscribeSubscribe
Entrée
emailstringrequisfirstNamestringfacultatiflastNamestringfacultatiftenantIdstringfacultatifsiteIdstringfacultatifhoneypotstringfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/newsletter.testConfirmationEmailTest Confirmation Email
Entrée
emailstring · emailrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/newsletter.testWelcomeEmailTest Welcome Email
Entrée
emailstring · emailrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/newsletter.unsubscribeUnsubscribe
Entrée
emailstringrequistokenstringfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/newsletter.updateSettingsUpdate Settings
Entrée
doubleOptInbooleanfacultatifpar défaut
falseconfirmationEmailTemplateIdstring · uuid | nullfacultatifconfirmationTokenExpirynumberfacultatif1–168 · par défaut
24welcomeEmailEnabledbooleanfacultatifpar défaut
truewelcomeEmailTemplateIdstring · uuid | nullfacultatifwelcomeEmailDelaynumberfacultatif0–10080 · par défaut
0unsubscribeConfirmationEnabledbooleanfacultatifpar défaut
trueunsubscribeConfirmationTemplateIdstring · uuid | nullfacultatifadminNotificationEnabledbooleanfacultatifpar défaut
falseadminNotificationEmailstring · email | ""facultatifadminDigestEnabledbooleanfacultatifpar défaut
falseadminDigestFrequencyenumfacultatif"daily" "weekly" · par défaut "daily"defaultFromNamestringfacultatifdefaultFromEmailstring · email | ""facultatifdefaultReplyTostring · email | ""facultatifautoArchiveEnabledbooleanfacultatifpar défaut
falsearchiveVisibilityenumfacultatif"public" "private" · par défaut "private"brandColorstringfacultatifpar défaut
"#146BFF"headerLogoUrlstring · uri | ""facultatiffooterTextstringfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/newsletter.updateSubscriberUpdate Subscriber
Entrée
idstring · uuidrequismarketingOptInbooleanfacultatifemailOptInbooleanfacultatifsmsOptInbooleanfacultatiffirstNamestringfacultatiflastNamestringfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
orders 48
POST/api/trpc/orders.createOrderItemCreate Order Item
Entrée
orderIdstring · uuidrequisnamestringrequis≥ 1 car.
descriptionstring | nullfacultatifquantityintegerrequis> 0–9007199254740991
unitPricenumberrequis≥ 0
productIdstring · uuid | nullfacultatifvendorIdstring · uuid | nullfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/orders.createOrderCreate Order
Entrée
invoiceNumberanyrequisinvoiceDateanyrequisdeliveryDateany | nullfacultatifinvoiceStatusenumrequis"DRAFT" "SENT" "PAID" "OVERDUE" "CANCELED" · par défaut "DRAFT"receiverIdstringfacultatifsenderIdstringfacultatifclientIdstringfacultatifcurrencystringrequispar défaut
"EUR"totalAmountnumberrequispar défaut
0additionalNotesstringfacultatifitemsobject[]requispar défaut
[]productIdstringfacultatifnamestringrequisdescriptionstring | nullfacultatifquantityintegerrequis> 0–9007199254740991
unitPricenumberrequis≥ 0
recalculateVendorsbooleanfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/orders.deleteOrderItemDelete Order Item
Entrée
idstring · uuidrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/orders.deleteOrderDelete Order
Entrée
idstringrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/orders.deleteOrdersDelete Orders
Entrée
idsstring[]requisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/orders.exportOrdersExport Orders
Entrée
formatenumrequis"csv" "xlsx" "json"filtersobjectfacultatifsearchstringfacultatifsortstringfacultatifadvancedFiltersany[]facultatifadvancedSortsobject[]facultatiffieldstringrequisdirectionenumrequis"asc" "desc"columnsstring[]facultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/orders.fetchOrdersFetch Orders
Entrée
Aucune entrée.
Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/orders.fulfillment.cancelFulfillment.cancel
Entrée
fulfillmentIdstring · uuidrequisreasonstringfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/orders.fulfillment.createFulfillment.create
Entrée
orderIdstring · uuidrequismethodenumrequis"SHIPPING" "PICKUP" "DIGITAL" "LOCAL_DELIVERY"itemsobject[]requis≥ 1 élém.
orderItemIdstring · uuidrequisquantityintegerrequis> 0–9007199254740991
carrierstringfacultatiftrackingNumberstringfacultatiftrackingUrlstring · urifacultatifestimatedDeliveryanyfacultatifshippingAddressobjectfacultatiffirstNamestringrequis≥ 1 car.
lastNamestringrequis≥ 1 car.
companystringfacultatifaddressstringrequis≥ 1 car.
citystringrequis≥ 1 car.
postalCodestringrequis≥ 1 car.
countrystringrequis≥ 1 car.
phonestringfacultatifemailstring · emailfacultatifinstructionsstringfacultatifshipmentIdstring · uuidfacultatifnotesstringfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
GET/api/trpc/orders.fulfillment.listByOrderFulfillment.list By Order
Entrée
orderIdstring · uuidrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
GET/api/trpc/orders.fulfillment.trackFulfillment.track
Entrée
fulfillmentIdstring · uuidrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/orders.fulfillment.updateStatusFulfillment.update Status
Entrée
fulfillmentIdstring · uuidrequisstatusenumrequis"PENDING" "PROCESSING" "READY_TO_SHIP" "SHIPPED" "IN_TRANSIT" "OUT_FOR_DELIVERY" "DELIVERED" "FAILED_DELIVERY" "RETURNED" "CANCELLED"trackingNumberstringfacultatiftrackingUrlstring · urifacultatifactualDeliveryanyfacultatifnotesstringfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
GET/api/trpc/orders.getCheckoutEventsGet Checkout Events
Entrée
orderIdstring · uuidrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
GET/api/trpc/orders.getInvoicesGet Invoices
Entrée
pageanyrequisper_pageanyrequissearchstringfacultatifsortstringfacultatiffiltersobjectfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/orders.getLiveOrdersGet Live Orders
Entrée
statusesenum[]facultatiflimitnumberrequispar défaut
50sortByenumrequis"invoiceDate" "createdAt" "updatedAt" · par défaut "invoiceDate"sortOrderenumrequis"asc" "desc" · par défaut "asc"Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/orders.getMyOrdersGet My Orders
Entrée
limitnumberrequis1–200 · par défaut
20cursorstringfacultatifstatusstringfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/orders.getOrderByIdGet Order By Id
Entrée
idstringrequisRéponse
200 Succès. Le résultat est dans
result.data.json : objectidstringfacultatifcreatedAtstringfacultatifupdatedAtstringfacultatifinvoiceNumberstringfacultatifreferenceanyfacultatifinvoiceDatestringfacultatifdeliveryDatestringfacultatiforderTypestringfacultatifinvoiceStatusstringfacultatiftotalAmountnumberfacultatifcurrencystringfacultatifsourceanyfacultatifpaymentIntentIdanyfacultatifstripeSessionIdanyfacultatifstripeInvoiceIdanyfacultatifplenigoOrderIdanyfacultatifexpiresAtanyfacultatifpaymentMethodanyfacultatifsenderIdstringfacultatifreceiverIdstringfacultatifclientIdstringfacultatifcustomInputsobjectfacultatifnotestringfacultatifvalidstringfacultatifstatusstringfacultatifcustomerobjectfacultatifemailstringfacultatiflastNamestringfacultatiffirstNamestringfacultatifreferencestringfacultatifpickup_slotanyfacultatifdelivery_datestringfacultatifdelivery_slotobjectfacultatifdaystringfacultatifhourstringfacultatifcauseanyfacultatifmanualbooleanfacultatifhour_endstringfacultatifremindedbooleanfacultatifmanual_commentanyfacultatifstore_informedbooleanfacultatifprestashop_idstringfacultatifinvoice_numberstringfacultatifpayment_methodstringfacultatifinvoice_addressobjectfacultatifcitystringfacultatifaddressstringfacultatifcountrystringfacultatifaddress2stringfacultatiflastNamestringfacultatifpostcodestringfacultatiffirstNamestringfacultatifdelivery_addressobjectfacultatifcitystringfacultatifaddressstringfacultatifcountrystringfacultatifaddress2stringfacultatiflastNamestringfacultatifpostcodestringfacultatiffirstNamestringfacultatifdeliveryDataHistoryobjectfacultatifentriesobject[]facultatifreasonstringfacultatifsourcestringfacultatifnewDatestringfacultatifoldDateanyfacultatifmetadataobjectfacultatiftimestampstringfacultatifcreatedAtstringfacultatiflastUpdatedstringfacultatiftenantIdstringfacultatifsiteIdstringfacultatifappliedVoucherIdanyfacultatifsubscriptionIdanyfacultatifisRenewalOrderbooleanfacultatifrequiresValidationbooleanfacultatifvalidatedAtanyfacultatifvalidatedByanyfacultatifprocessedAtanyfacultatifprocessedByanyfacultatifitemsobject[]facultatifidstringfacultatifcreatedAtstringfacultatifupdatedAtstringfacultatifnamestringfacultatifdescriptionstringfacultatifquantityintegerfacultatifunitPricenumberfacultatifdataobjectfacultatifgenericMappingobjectfacultatifmappedQuantityintegerfacultatifconversionFactornumberfacultatifgenericProductIdstringfacultatiforiginalQuantityintegerfacultatifexternalProductIdstringfacultatifexternalOrderIdstringfacultatifexternalProductIdstringfacultatifexternalVendorIdanyfacultatifexternalItemIdstringfacultatiforderIdstringfacultatifproductIdstringfacultatifproductVariationIdanyfacultatifvendorIdstringfacultatifvoucherDiscountAmountanyfacultatifsiteIdstringfacultatifproductobjectfacultatifidstringfacultatifnamestringfacultatifreferencestringfacultatifskuanyfacultatifpriceintegerfacultatifsalePriceanyfacultatifmainImageIdanyfacultatif_countobjectfacultatifbundleComponentsintegerfacultatifvendorobjectfacultatifidstringfacultatifnamestringfacultatifemailstringfacultatifclientobjectfacultatifidstringfacultatifnamestringfacultatifemailstringfacultatifphonestringfacultatifaddressstringfacultatifzipCodestringfacultatifcitystringfacultatifcountrystringfacultatifsiretanyfacultatifisProfessionalbooleanfacultatifsenderobjectfacultatifidstringfacultatifnameanyfacultatifemailstringfacultatifreceiverobjectfacultatifidstringfacultatifnamestringfacultatifemailstringfacultatifvendorsany[]facultatifEssayer
GET/api/trpc/orders.getOrderItemsGet Order Items
Entrée
orderIdstringrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/orders.getOrdersByIdsForProductsGet Orders By Ids For Products
Entrée
idsstring[]requis1–200 élém.
productIdsstring · uuid[]facultatifincludeItemsbooleanfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/orders.getOrdersByIdsGet Orders By Ids
Entrée
idsstring[]requis1–50 élém.
productIdstring · uuidfacultatifincludeItemsbooleanfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/orders.getOrdersByProductGet Orders By Product
Entrée
productIdstring · uuidrequispageanyrequisper_pageanyrequissearchstring | nullfacultatifstatusenum | nullfacultatifsortstring | nullfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
GET/api/trpc/orders.getOrdersByVendorGet Orders By Vendor
Entrée
vendorIdstring · uuidrequispagenumberrequispar défaut
0per_pagenumberrequispar défaut
50searchstringfacultatifstatusenumfacultatif"DRAFT" "SENT" "PAID" "OVERDUE" "CANCELED"statusesenum[]facultatifdeliveryDateFromstringfacultatifdeliveryDateTostringfacultatifsortstringfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
GET/api/trpc/orders.getOrdersGet Orders
Entrée
pageanyrequisper_pageanyrequissearchstring | nullfacultatifsortstring | nullfacultatiffiltersobjectrequispar défaut
{}advancedFiltersany[]requispar défaut
[]advancedSortsobject[]requispar défaut
[]fieldstringrequisdirectionenumrequis"asc" "desc"fieldsenum | string[]facultatifpar défaut
"detailed"paymentLinkFilterenumfacultatif"all" "exclude" "only" · par défaut "all"offlinePaymentFilterenumfacultatif"all" "only" · par défaut "all"Réponse
200 Succès. Le résultat est dans
result.data.json : objectdataobject[]facultatifidstringfacultatifinvoiceNumberstringfacultatifinvoiceDatestringfacultatifinvoiceStatusstringfacultatiftotalAmountnumberfacultatifcurrencystringfacultatifcreatedAtstringfacultatifupdatedAtstringfacultatifpaymentMethodanyfacultatifexpiresAtanyfacultatifdeliveryDatestringfacultatifcustomInputsobjectfacultatifnotestringfacultatifvalidstringfacultatifstatusstringfacultatifcustomerobjectfacultatifemailstringfacultatiflastNamestringfacultatiffirstNamestringfacultatifreferencestringfacultatifpickup_slotanyfacultatifdelivery_datestringfacultatifdelivery_slotobjectfacultatifdaystringfacultatifhourstringfacultatifcauseanyfacultatifmanualbooleanfacultatifhour_endstringfacultatifremindedbooleanfacultatifmanual_commentanyfacultatifstore_informedbooleanfacultatifprestashop_idstringfacultatifinvoice_numberstringfacultatifpayment_methodstringfacultatifinvoice_addressobjectfacultatifcitystringfacultatifaddressstringfacultatifcountrystringfacultatifaddress2stringfacultatiflastNamestringfacultatifpostcodestringfacultatiffirstNamestringfacultatifdelivery_addressobjectfacultatifcitystringfacultatifaddressstringfacultatifcountrystringfacultatifaddress2stringfacultatiflastNamestringfacultatifpostcodestringfacultatiffirstNamestringfacultatifdeliveryDataHistoryobjectfacultatifentriesobject[]facultatifcreatedAtstringfacultatiflastUpdatedstringfacultatifsourceanyfacultatifreceiverobjectfacultatifidstringfacultatifnamestringfacultatifemailstringfacultatifsenderobjectfacultatifidstringfacultatifnameanyfacultatifemailstringfacultatifclientobjectfacultatifidstringfacultatifnamestringfacultatifemailstringfacultatifvendorsany[]facultatifitemsobject[]facultatifidstringfacultatifnamestringfacultatifdescriptionstringfacultatifquantityintegerfacultatifunitPricenumberfacultatifproductobjectfacultatifidstringfacultatifnamestringfacultatifreferencestringfacultatifskuanyfacultatifpriceintegerfacultatifsalePriceanyfacultatifmainImageIdanyfacultatiftotalintegerfacultatifpageintegerfacultatifpageSizeintegerfacultatifpageCountintegerfacultatifhasNextPagebooleanfacultatifhasPrevPagebooleanfacultatifEssayer
GET/api/trpc/orders.getOrderSubscriptionContextGet Order Subscription Context
Entrée
orderIdstringrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/orders.getOrderTimersGet Order Timers
Entrée
orderIdsstring[]facultatifactiveOnlybooleanrequispar défaut
trueRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/orders.getProductsByOrderGet Products By Order
Entrée
orderIdstring · uuidrequispageanyrequisper_pageanyrequissearchstring | nullfacultatifsortstring | nullfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
GET/api/trpc/orders.getRelatedSupplierOrdersGet Related Supplier Orders
Entrée
orderIdstring · uuidrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
GET/api/trpc/orders.getUnfulfilledOrdersGet Unfulfilled Orders
Entrée
searchstringfacultatiflimitnumberfacultatifpar défaut
50Réponse
200 Succès. Le résultat est dans
result.data.json : objectordersobject[]facultatifidstringfacultatifnumberstringfacultatifstatusstringfacultatifcustomerNamestringfacultatifcustomerobjectfacultatifidstringfacultatifnamestringfacultatifemailstringfacultatifcreatedAtstringfacultatifitemsobject[]facultatifidstringfacultatifproductIdstringfacultatifproductNamestringfacultatifquantityintegerfacultatifproductobjectfacultatifidstringfacultatifnamestringfacultatifdefaultVendorIdstringfacultatifdefaultVendorobjectfacultatifstockintegerfacultatifstockAvailabilityanyfacultatiftotalintegerfacultatifEssayer
POST/api/trpc/orders.lifecycle.cancelOrderLifecycle.cancel Order
Entrée
orderIdstring · uuidrequisreleaseStockbooleanrequispar défaut
trueRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/orders.lifecycle.confirmOrderPaymentLifecycle.confirm Order Payment
Entrée
orderIdstring · uuidrequispaymentIntentIdstringfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/orders.lifecycle.expireDraftOrdersLifecycle.expire Draft Orders
Entrée
tenantIdstring · uuidfacultatifsiteIdstring · uuidfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/orders.lifecycle.getDashboardDataLifecycle.get Dashboard Data
Entrée
timeRangeenumrequis"today" "7d" "30d" · par défaut "7d"alertsLimitintegerrequis1–50 · par défaut
10Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/orders.lifecycle.getLifecycleAlertsLifecycle.get Lifecycle Alerts
Entrée
limitintegerrequis1–50 · par défaut
10Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/orders.lifecycle.getLifecycleStatsLifecycle.get Lifecycle Stats
Entrée
timeRangeenumrequis"today" "7d" "30d" · par défaut "7d"Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/orders.lifecycle.getOrdersExpiringSoonLifecycle.get Orders Expiring Soon
Entrée
minutesUntilExpiryintegerrequis1–60 · par défaut
15tenantIdstring · uuidfacultatifsiteIdstring · uuidfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/orders.markPaidMark Paid
Entrée
orderIdstring · uuidrequispaymentIntentIdstringrequispaymentMethodstringfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/orders.markProcessedMark Processed
Entrée
orderIdstring · uuidrequisprocessedbooleanrequispar défaut
trueRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
GET/api/trpc/orders.refund.calculateRefund.calculate
Entrée
orderIdstring · uuidrequisitemsobject[]facultatiforderItemIdstring · uuidrequisquantityintegerrequis> 0–9007199254740991
Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/orders.refund.createRefund.create
Entrée
orderIdstring · uuidrequisitemsobject[]facultatiforderItemIdstring · uuidrequisquantityintegerrequis> 0–9007199254740991
amountnumberfacultatif≥ > 0
reasonenumrequis"CUSTOMER_REQUEST" "DEFECTIVE_PRODUCT" "WRONG_ITEM" "NOT_AS_DESCRIBED" "DAMAGED_SHIPPING" "DUPLICATE_PAYMENT" "FRAUDULENT_TRANSACTION" "CANCELLED_ORDER" "RETURN_POLICY" "GOODWILL" …reasonDescriptionstringfacultatifnotesstringfacultatifautoApprovebooleanrequispar défaut
falseRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/orders.refund.executeRefund.execute
Entrée
refundIdstring · uuidrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
GET/api/trpc/orders.refund.listByOrderRefund.list By Order
Entrée
orderIdstring · uuidrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/orders.refund.processRefund.process
Entrée
refundIdstring · uuidrequisapprovebooleanrequisnotesstringfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/orders.syncOrderSync Order
Entrée
orderIdstring · uuidrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/orders.updateKitchenStatusUpdate Kitchen Status
Entrée
idstringrequiskitchenStatusenumrequis"received" "preparing" "ready" "completed"notesstringfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/orders.updateOrderItemUpdate Order Item
Entrée
object
Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/orders.updateOrderUpdate Order
Entrée
idstringrequisinvoiceNumberanyrequisinvoiceDateanyfacultatifdeliveryDateany | nullfacultatifinvoiceStatusenumfacultatif"DRAFT" "SENT" "PAID" "OVERDUE" "CANCELED"receiverIdstring | nullfacultatifsenderIdstring | nullfacultatifclientIdstring | nullfacultatifvendorIdsstring[]facultatifcurrencystringfacultatiftotalAmountnumberfacultatifadditionalNotesstringfacultatifitemsobject[]facultatifidstringfacultatifproductIdstringfacultatifnamestringrequisdescriptionstring | nullfacultatifquantityintegerrequis> 0–9007199254740991
unitPricenumberrequis≥ 0
recalculateVendorsbooleanfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/orders.updateStatusUpdate Status
Entrée
idstringrequisstatusenumrequis"DRAFT" "SENT" "PAID" "OVERDUE" "CANCELED"Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/orders.validateOrderValidate Order
Entrée
orderIdstring · uuidrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
payments 24
POST/api/trpc/payments.applyMyUpdatedCardApply My Updated Card
Entrée
printSubscriptionIdstring · uuidrequispaymentMethodIdstringrequis≥ 1 car.
Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
GET/api/trpc/payments.checkStripeConfigurationCheck Stripe Configuration
Entrée
Aucune entrée.
Réponse
200 Succès. Le résultat est dans
result.data.json : objectisConfiguredbooleanfacultatifEssayer
POST/api/trpc/payments.createEditionCheckoutSessionCreate Edition Checkout Session
Entrée
editionIdstring · uuidrequisorderIdstring · uuidfacultatifsuccessUrlstringfacultatifcancelUrlstringfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/payments.createMagazineCheckoutSessionCreate Magazine Checkout Session
Entrée
subscriptionPlanIdstring · uuidrequissuccessUrlstringfacultatifcancelUrlstringfacultatifpreviousSubIdstring · uuidfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/payments.createMagazinePurchaseCheckoutSessionCreate Magazine Purchase Checkout Session
Entrée
itemsobject[]requis1–50 élém.
idstring · uuidrequistitlestringrequispricenumberfacultatifquantityintegerrequis1–100
formatenumfacultatif"numerique" "papier" "combo"kindenumfacultatif"subscription" "magazine"durationYears1 | 2facultatifisMonthlybooleanfacultatifisGiftbooleanfacultatifgiftRecipientobjectfacultatiffirstNamestringrequis≥ 1 car.
lastNamestringrequis≥ 1 car.
emailstring · emailrequisaddressstringrequis≥ 1 car.
postalCodestringrequis≥ 1 car.
citystringrequis≥ 1 car.
countrystringrequis≥ 1 car.
messagestringfacultatifcountryenumrequis"FR" "WORLD" · par défaut "FR"customerInfoobjectfacultatifcivilitystringfacultatiffirstNamestringrequislastNamestringrequisemailstring · emailrequisphonestringrequiscompanystringfacultatifaddressstringrequisaddress2stringfacultatifcitystringrequispostalCodestringrequiscountrystringrequisnotesstringfacultatifbillingInfoobjectfacultatifaddressstringrequisaddress2stringfacultatifcitystringrequispostalCodestringrequiscountrystringrequisdeliveryOptionstringfacultatifpaymentMethodstringfacultatiftotalsobjectfacultatifsubtotalnumberrequisdeliverynumberrequistotalnumberrequissuccessUrlstringfacultatifcancelUrlstringfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/payments.createMyUpdateCardSetupIntentCreate My Update Card Setup Intent
Entrée
printSubscriptionIdstring · uuidrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/payments.createOfflineMagazineCheckoutCreate Offline Magazine Checkout
Entrée
itemsobject[]requis≥ 1 élém.
idstringrequistitlestringfacultatifpricenumberfacultatifquantityintegerrequis1–100 · par défaut
1formatenumfacultatif"numerique" "papier" "combo"kindenumfacultatif"subscription" "magazine"durationYears1 | 2facultatifisMonthlybooleanfacultatifisGiftbooleanfacultatifcountryenumrequis"FR" "WORLD" · par défaut "FR"paymentMethodenumrequis"BANK_TRANSFER" "CHEQUE"customerInfoobjectrequiscivilitystringfacultatiffirstNamestringrequis≥ 1 car.
lastNamestringrequis≥ 1 car.
emailstring · emailrequisphonestringrequis≥ 1 car.
companystringfacultatifaddressstringrequis≥ 1 car.
address2stringfacultatifcitystringrequis≥ 1 car.
postalCodestringrequis≥ 1 car.
countrystringrequis≥ 1 car.
notesstringfacultatifbillingInfoobjectfacultatifaddressstringrequisaddress2stringfacultatifcitystringrequispostalCodestringrequiscountrystringrequistotalsobjectfacultatifsubtotalnumberfacultatifdeliverynumberfacultatiftotalnumberrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/payments.createOfflineMagazineSubscriptionCheckoutCreate Offline Magazine Subscription Checkout
Entrée
magazineSubscriptionPlanIdstring · uuidrequisisMonthlytruerequiscountryenumrequis"FR" "WORLD" · par défaut "FR"paymentMethodenumrequis"BANK_TRANSFER" "CHEQUE"customerInfoobjectrequiscivilitystringfacultatiffirstNamestringrequis≥ 1 car.
lastNamestringrequis≥ 1 car.
emailstring · emailrequisphonestringrequis≥ 1 car.
companystringfacultatifaddressstringrequis≥ 1 car.
address2stringfacultatifcitystringrequis≥ 1 car.
postalCodestringrequis≥ 1 car.
countrystringrequis≥ 1 car.
notesstringfacultatifbillingInfoobjectfacultatifaddressstringrequisaddress2stringfacultatifcitystringrequispostalCodestringrequiscountrystringrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/payments.createOperatorCardSubscriptionCreate Operator Card Subscription
Entrée
targetContactIdstring · uuidrequismagazineSubscriptionPlanIdstring · uuidrequiscountryenumrequis"FR" "WORLD" · par défaut "FR"modeenumrequis"RECURRING_MONTHLY" "RECURRING_QUARTERLY" "PER_ISSUE"stripeCustomerIdstringrequis≥ 1 car.
paymentMethodIdstringrequis≥ 1 car.
Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/payments.createOperatorSetupIntentCreate Operator Setup Intent
Entrée
targetContactIdstring · uuidrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/payments.createPaymentIntentCreate Payment Intent
Entrée
orderIdstring · uuidrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/payments.createPerIssueCardSetupCheckoutCreate Per Issue Card Setup Checkout
Entrée
magazineSubscriptionPlanIdstring · uuidrequiscountryenumrequis"FR" "WORLD" · par défaut "FR"customerEmailstring · emailrequiscustomerFirstNamestringrequis≥ 1 car.
customerLastNamestringrequis≥ 1 car.
successUrlstring · urirequiscancelUrlstring · urirequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/payments.createRecurringMagazineSubscriptionCheckoutCreate Recurring Magazine Subscription Checkout
Entrée
magazineSubscriptionPlanIdstring · uuidrequiscountryenumrequis"FR" "WORLD" · par défaut "FR"interval"month"requispar défaut
"month"intervalCount1 | 3requispar défaut
1successUrlstring · urirequiscancelUrlstring · urirequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/payments.createRecurringMagazineSubscriptionLinkForCustomerCreate Recurring Magazine Subscription Link For Customer
Entrée
magazineSubscriptionPlanIdstring · uuidrequistargetContactIdstring · uuidrequiscountryenumrequis"FR" "WORLD" · par défaut "FR"interval"month"requispar défaut
"month"intervalCount1 | 3requispar défaut
1successUrlstring · urirequiscancelUrlstring · urirequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/payments.createVisitCheckoutSessionCreate Visit Checkout Session
Entrée
reservationIdstring · uuidrequissuccessUrlstringfacultatifcancelUrlstringfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
GET/api/trpc/payments.getCheckoutFunnelGet Checkout Funnel
Entrée
fromstringfacultatiftostringfacultatifRéponse
200 Succès. Le résultat est dans
result.data.json : objectwindowobjectfacultatiffromstringfacultatiftostringfacultatiffunnelobjectfacultatifreachedCheckoutintegerfacultatifpayClickedintegerfacultatifsessionCreatedintegerfacultatifcompletedintegerfacultatifprocessingintegerfacultatifmintedEventsintegerfacultatifexpiredintegerfacultatifabandonedFrontendintegerfacultatiferrorsintegerfacultatifrevenueobjectfacultatifpaidCountintegerfacultatifpaidAmountintegerfacultatifcurrencystringfacultatifpendingobjectfacultatifinflightintegerfacultatifabandonedintegerfacultatifeventsByKindany[]facultatifEssayer
GET/api/trpc/payments.getMagazineCartPricingGet Magazine Cart Pricing
Entrée
itemsobject[]requis1–100 élém.
idstring · uuidrequisformatenumfacultatif"numerique" "papier" "combo"Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
GET/api/trpc/payments.getPaymentMethodsGet Payment Methods
Entrée
Aucune entrée.
Réponse
200 Succès. Le résultat est dans
result.data.json : object[]idstringfacultatifnamestringfacultatiftypestringfacultatifisActivebooleanfacultatifEssayer
GET/api/trpc/payments.getPaymentStatsGet Payment Stats
Entrée
dateFromanyfacultatifdateToanyfacultatifRéponse
200 Succès. Le résultat est dans
result.data.json : objecttotalTransactionsintegerfacultatiftotalAmountnumberfacultatifcompletedTransactionsintegerfacultatiffailedTransactionsintegerfacultatifpendingTransactionsintegerfacultatifprocessingTransactionsintegerfacultatifcancelledTransactionsintegerfacultatiftotalProcessingFeesnumberfacultatifaverageTransactionAmountnumberfacultatifEssayer
GET/api/trpc/payments.getStripeConfigurationGet Stripe Configuration
Entrée
Aucune entrée.
Réponse
200 Succès. Le résultat est dans
result.data.json : objectsecretKeyanyfacultatifpublishableKeyanyfacultatifisConfiguredbooleanfacultatifEssayer
GET/api/trpc/payments.getTransactionByIdGet Transaction By Id
Entrée
idstringrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/payments.getTransactionsGet Transactions
Entrée
pageintegerrequis1–9007199254740991 · par défaut
1per_pageintegerrequis1–100 · par défaut
20dateFromanyfacultatifdateToanyfacultatifstatusenumfacultatif"PENDING" "PROCESSING" "COMPLETED" "FAILED" "CANCELLED"paymentMethodstringfacultatiforderIdstring · uuidfacultatifcustomerIdstring · uuidfacultatifRéponse
200 Succès. Le résultat est dans
result.data.json : objecttransactionsany[]facultatiftotalintegerfacultatifpageintegerfacultatifper_pageintegerfacultatiftotalPagesintegerfacultatifEssayer
GET/api/trpc/payments.listAbandonedCheckoutsList Abandoned Checkouts
Entrée
stateenumrequis"abandoned" "inflight" "all" · par défaut "abandoned"limitnumberrequis1–200 · par défaut
50Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/payments.updateStripeConfigurationUpdate Stripe Configuration
Entrée
secretKeystringrequis≥ 1 car.
publishableKeystringrequis≥ 1 car.
Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
products 27
POST/api/trpc/products.assignSubCategoryToProductAssign Sub Category To Product
Entrée
productIdstring · uuidrequissubCategoryIdstring · uuidrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/products.bulkUpdateBulk Update
Entrée
updatesobject[]requisidstring · uuidrequisnamestringfacultatif≥ 1 car.
descriptionstringfacultatifreferencestringfacultatifmanufacturerstringfacultatifactivebooleanfacultatifpricenumberfacultatif≥ 0
proPricenumber | nullfacultatiftaxRatenumberfacultatif0–100
isBuyablebooleanfacultatifpackagingQuantitynumberfacultatif≥ > 0
packagingUnitstringfacultatifsaleDetailstringfacultatifsaleQuantitynumberfacultatif≥ > 0
saleUnitstringfacultatifsaleTypestringfacultatifstockintegerfacultatif0–9007199254740991
defaultVendorIdstringfacultatifpackagingTypeIdstringfacultatifdataPatchobjectfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/products.byPackagingTypeBy Packaging Type
Entrée
packagingTypeIdstringrequispagenumberrequispar défaut
0limitnumberrequispar défaut
50Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/products.clearProductsCacheClear Products Cache
Entrée
Aucune entrée.
Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/products.createCreate
Entrée
namestringrequis≥ 2 car.
descriptionstringfacultatifpricenumberrequis≥ 0
proPricenumber | nullfacultatifreferencestringfacultatifmanufacturerstringfacultatiftaxRatenumberrequis0–100 · par défaut
20defaultVendorIdstringfacultatifpackagingTypeIdstringfacultatifpackagingQuantitynumberfacultatif≥ > 0
packagingUnitstringfacultatifsaleDetailstringfacultatifsaleQuantitynumberfacultatif≥ > 0
saleUnitstringfacultatifsaleTypestringfacultatifdefaultTemplateIdstringfacultatifisBuyablebooleanrequispar défaut
trueactivebooleanrequispar défaut
truemainImageIdstring | nullfacultatifimagesstring[]requispar défaut
[]productTypeenumfacultatif"SIMPLE" "VARIABLE" "COMPOSITE" "FORMULE" "MENU" · par défaut "SIMPLE"manageStockbooleanfacultatifpar défaut
falsestockintegerfacultatif0–9007199254740991
lowStockThresholdintegerfacultatif0–9007199254740991
soldIndividuallybooleanfacultatifpar défaut
falseweightUnitstringfacultatifrequiresLotNumberbooleanfacultatifpar défaut
falseshowOrderDetailsbooleanfacultatifpar défaut
falseisPerishablebooleanfacultatifpar défaut
falseperishabilityDaysintegerfacultatif1–365
deliveryDaysintegerfacultatif1–30
specificOveragePercentintegerfacultatif0–100
weightnumberfacultatif≥ 0
lengthnumberfacultatif≥ > 0
widthnumberfacultatif≥ > 0
heightnumberfacultatif≥ > 0
purchaseNotestringfacultatifmenuOrderintegerfacultatif-9007199254740991–9007199254740991
isGenericbooleanfacultatifpar défaut
falseRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/products.createWithAllNeedsCreate With All Needs
Entrée
Aucune entrée.
Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/products.deleteAllProductsDelete All Products
Entrée
confirmationIdstringrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/products.deleteGenericLinkDelete Generic Link
Entrée
idstring · uuidrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/products.deleteProductDelete Product
Entrée
idstringrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/products.getByIdGet By Id
Entrée
idstringrequisRéponse
200 Succès. Le résultat est dans
result.data.json : objectidstringfacultatifreferencestringfacultatifplenigoOfferIdanyfacultatifplenigoAccessRightUniqueIdanyfacultatifnamestringfacultatifdescriptionstringfacultatifpricenumberfacultatifsalePriceanyfacultatifproPriceanyfacultatifpurchasePricenumberfacultatifstockintegerfacultatifstockLedgerintegerfacultatifisBuyablebooleanfacultatifskustringfacultatifisGenericbooleanfacultatifmagazineEditionIdanyfacultatifsiteIdstringfacultatifproductTypestringfacultatifmanageStockbooleanfacultatiflowStockThresholdanyfacultatifsoldIndividuallybooleanfacultatifweightanyfacultatiflengthanyfacultatifwidthanyfacultatifheightanyfacultatifpurchaseNoteanyfacultatifmenuOrderanyfacultatifdataobjectfacultatiflastSyncstringfacultatifprestashop_idstringfacultatifprestashop_dataobjectfacultatifmpnstringfacultatifupcstringfacultatifisbnstringfacultatifnamestringfacultatifratenumberfacultatifdepthintegerfacultatifean13stringfacultatifpricenumberfacultatifunitystringfacultatifwidthintegerfacultatifactivestringfacultatifheightintegerfacultatifweightintegerfacultatifdate_addstringfacultatifdate_updstringfacultatifquantityintegerfacultatifprice_ttcnumberfacultatifreferencestringfacultatifid_productstringfacultatifdescriptionstringfacultatifid_supplierstringfacultatiflink_rewritestringfacultatifsupplier_namestringfacultatifid_manufacturerstringfacultatifwholesale_pricenumberfacultatifbundle_componentsany[]facultatifdescription_shortstringfacultatiflinked_categoriesobject[]facultatifnamestringfacultatifslugstringfacultatifpositionintegerfacultatifid_categoryintegerfacultatifmanufacturer_namestringfacultatifid_tax_rules_groupintegerfacultatifavailable_for_orderstringfacultatifid_category_defaultstringfacultatifmanufacturerstringfacultatiftaxRatenumberfacultatifactivebooleanfacultatifdefaultVendorIdstringfacultatifpackagingTypeIdanyfacultatifpackagingQuantityanyfacultatifpackagingUnitanyfacultatifsaleDetailanyfacultatifsaleQuantityanyfacultatifsaleUnitanyfacultatifsaleTypeanyfacultatifdefaultTemplateIdanyfacultatifapprovisionnementintegerfacultatifweightUnitanyfacultatifrequiresLotNumberbooleanfacultatifshowOrderDetailsbooleanfacultatifisPerishablebooleanfacultatifperishabilityDaysanyfacultatifdeliveryDaysanyfacultatifspecificOveragePercentanyfacultatifcreatedByIdstringfacultatifwarehouseIdanyfacultatifexternalIdstringfacultatifsyncedAtanyfacultatiflastSyncedAtanyfacultatifsourcestringfacultatifmainImageIdanyfacultatifcreatedAtstringfacultatifupdatedAtstringfacultatiftenantIdstringfacultatiftagsIdanyfacultatifisMaterialbooleanfacultatifisFinishedProductbooleanfacultatifmanufacturingLeadTimeanyfacultatifsafetyStockanyfacultatifreorderPointanyfacultatifmoqanyfacultatifmanufacturingCostanyfacultatifsubscriptionEnabledbooleanfacultatifsubscriptionDurationDaysanyfacultatifstripeProductIdanyfacultatifstripePriceIdanyfacultatifstripeRecurringPriceIdanyfacultatifimagesany[]facultatifmainImageanyfacultatifdefaultVendorobjectfacultatifidstringfacultatifnamestringfacultatifemailstringfacultatifaddressstringfacultatifdescriptionstringfacultatifdefaultTemplateIdanyfacultatifexternalIdstringfacultatifcontactstringfacultatifsendEmailstring[]facultatifsendSchedulesobject[]facultatifdaystringfacultatiftimestringfacultatifsendTypestringfacultatifsendChannelstringfacultatifsendAuthorizedbooleanfacultatifgroupedOrderbooleanfacultatifautoSendbooleanfacultatiforderSettingsanyfacultatifapprovisionnementintegerfacultatifuseStockLedgerbooleanfacultatifdefaultOveragePercentintegerfacultatifspecificOveragePercentanyfacultatifdeliveryDaysintegerfacultatifdefaultPackagingTypeIdanyfacultatifdataobjectfacultatifcitystringfacultatifnamestringfacultatifphonestringfacultatifactivebooleanfacultatifcountrystringfacultatifaddress1stringfacultatifaddress2stringfacultatifdate_addstringfacultatifdate_updstringfacultatiflogo_urlstringfacultatifpostcodestringfacultatifmeta_titlestringfacultatifvat_numberstringfacultatifdescriptionstringfacultatifhas_addressbooleanfacultatifhas_contactbooleanfacultatifid_supplierstringfacultatifvendor_typestringfacultatifcontact_namestringfacultatifhas_productsbooleanfacultatifphone_mobilestringfacultatifmeta_keywordsstringfacultatifproduct_countintegerfacultatifaddress_companystringfacultatifcontact_lastnamestringfacultatifmeta_descriptionstringfacultatifcontact_firstnamestringfacultatifsupplier_referencesstringfacultatifmainImageIdanyfacultatifcreatedAtstringfacultatifupdatedAtstringfacultatifuserIdanyfacultatiftenantIdstringfacultatifsiteIdstringfacultatifparentVendorIdanyfacultatifcsvConfiganyfacultatifdefaultTemplateanyfacultatifpackagingTypeanyfacultatifassignedSubCategoriesobject[]facultatifidstringfacultatifproductIdstringfacultatifsubCategoryIdstringfacultatifassignedAtstringfacultatifassignedBystringfacultatiftenantIdstringfacultatifsiteIdstringfacultatifsubCategoryobjectfacultatifidstringfacultatifnamestringfacultatifslugstringfacultatifdescriptionstringfacultatifimageIdanyfacultatiforderanyfacultatifexternalIdstringfacultatifdataobjectfacultatifprestashop_dataobjectfacultatifparentCategoryIdstringfacultatifmainCategoryIdstringfacultatifcreatedAtstringfacultatifupdatedAtstringfacultatiftenantIdstringfacultatifsiteIdstringfacultatiftagsany[]facultatifassignedAttributesany[]facultatifassignedOptionListsany[]facultatifvariationsany[]facultatifvariantsany[]facultatifupsellsany[]facultatifcrossSellsany[]facultatifbundleComponentsany[]facultatifgenericLinksany[]facultatifparentGenericLinksany[]facultatifeffectivePricenumberfacultatifpriceLabelstringfacultatifprestashopActivebooleanfacultatifisbnanyfacultatifean13anyfacultatifupcanyfacultatifmpnanyfacultatifppomanyfacultatifppomNormalizedanyfacultatifEssayer
GET/api/trpc/products.getBySlugGet By Slug
Entrée
slugstringrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/products.getCacheStatusGet Cache Status
Entrée
Aucune entrée.
Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/products.getOrdersByProductIdGet Orders By Product Id
Entrée
productIdstringrequispagenumberrequispar défaut
1limitnumberrequispar défaut
20sortstring | nullfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/products.getProductsByIdsGet Products By Ids
Entrée
idsstring[]requisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/products.getProductsGet Products
Entrée
defaultVendorIdstringfacultatifpagenumberrequispar défaut
0per_pagenumberrequispar défaut
10searchstringfacultatifstockFilterstringfacultatifcategoryFilterstringfacultatifactiveFilterstringfacultatifbuyableFilterstringfacultatifpriceRangeFilterstringfacultatifgenericFilterstringfacultatifbundleFilterstringfacultatifproductTypeFilterenumfacultatif"SIMPLE" "VARIABLE" "COMPOSITE" "FORMULE" "MENU"subscriptionFilterenumfacultatif"true" "false"publicationIdstringfacultatifbundleIdstringfacultatifsortOrderstringrequispar défaut
"createdAt:desc"sortMultipleobject[]facultatiffieldstringrequisdirectionenumrequis"asc" "desc"excludeIdsstring[]facultatifRéponse
200 Succès. Le résultat est dans
result.data.json : objectitemsobject[]facultatifidstringfacultatifreferencestringfacultatifplenigoOfferIdanyfacultatifplenigoAccessRightUniqueIdanyfacultatifnamestringfacultatifdescriptionstringfacultatifpricenumberfacultatifsalePriceanyfacultatifproPriceanyfacultatifpurchasePricenumberfacultatifstockintegerfacultatifstockLedgerintegerfacultatifisBuyablebooleanfacultatifskustringfacultatifisGenericbooleanfacultatifmagazineEditionIdanyfacultatifsiteIdstringfacultatifproductTypestringfacultatifmanageStockbooleanfacultatiflowStockThresholdintegerfacultatifsoldIndividuallybooleanfacultatifweightanyfacultatiflengthanyfacultatifwidthanyfacultatifheightanyfacultatifpurchaseNoteanyfacultatifmenuOrderanyfacultatifdataobjectfacultatiflastSyncstringfacultatifprestashop_idstringfacultatifprestashop_dataobjectfacultatifmpnstringfacultatifupcstringfacultatifisbnstringfacultatifnamestringfacultatifratenumberfacultatifdepthintegerfacultatifean13stringfacultatifpricenumberfacultatifunitystringfacultatifwidthintegerfacultatifactivestringfacultatifheightintegerfacultatifweightintegerfacultatifdate_addstringfacultatifdate_updstringfacultatifquantityintegerfacultatifprice_ttcnumberfacultatifreferencestringfacultatifid_productstringfacultatifdescriptionstringfacultatifid_supplierstringfacultatiflink_rewritestringfacultatifsupplier_namestringfacultatifid_manufacturerstringfacultatifwholesale_pricenumberfacultatifbundle_componentsany[]facultatifdescription_shortstringfacultatiflinked_categoriesobject[]facultatifmanufacturer_namestringfacultatifid_tax_rules_groupintegerfacultatifavailable_for_orderstringfacultatifid_category_defaultstringfacultatifmanufacturerstringfacultatiftaxRatenumberfacultatifactivebooleanfacultatifdefaultVendorIdstringfacultatifpackagingTypeIdstringfacultatifpackagingQuantityintegerfacultatifpackagingUnitstringfacultatifsaleDetailanyfacultatifsaleQuantitynumberfacultatifsaleUnitstringfacultatifsaleTypestringfacultatifdefaultTemplateIdanyfacultatifapprovisionnementintegerfacultatifweightUnitanyfacultatifrequiresLotNumberbooleanfacultatifshowOrderDetailsbooleanfacultatifisPerishablebooleanfacultatifperishabilityDaysanyfacultatifdeliveryDaysanyfacultatifspecificOveragePercentanyfacultatifcreatedByIdstringfacultatifwarehouseIdanyfacultatifexternalIdstringfacultatifsyncedAtanyfacultatiflastSyncedAtanyfacultatifsourcestringfacultatifmainImageIdanyfacultatifcreatedAtstringfacultatifupdatedAtstringfacultatiftenantIdstringfacultatiftagsIdanyfacultatifisMaterialbooleanfacultatifisFinishedProductbooleanfacultatifmanufacturingLeadTimeanyfacultatifsafetyStockanyfacultatifreorderPointanyfacultatifmoqanyfacultatifmanufacturingCostanyfacultatifsubscriptionEnabledbooleanfacultatifsubscriptionDurationDaysanyfacultatifstripeProductIdanyfacultatifstripePriceIdanyfacultatifstripeRecurringPriceIdanyfacultatifmainImageanyfacultatifpackagingTypeobjectfacultatifidstringfacultatifnamestringfacultatifsizestringfacultatiforderByQuantityanyfacultatifdescriptionstringfacultatifcreatedAtstringfacultatifupdatedAtstringfacultatiftenantIdstringfacultatifdefaultVendorobjectfacultatifidstringfacultatifnamestringfacultatifuseStockLedgerbooleanfacultatifstockAvailabilityany[]facultatifmagazineEditionanyfacultatifassignedSubCategoriesobject[]facultatifidstringfacultatifproductIdstringfacultatifsubCategoryIdstringfacultatifassignedAtstringfacultatifassignedBystringfacultatiftenantIdstringfacultatifsiteIdstringfacultatifsubCategoryobjectfacultatifidstringfacultatifnamestringfacultatifmainCategoryobjectfacultatif_countobjectfacultatifbundleComponentsintegerfacultatifprestashopActivebooleanfacultatiftotalintegerfacultatifpageintegerfacultatifper_pageintegerfacultatifpagesintegerfacultatifEssayer
GET/api/trpc/products.getVendorOrdersByProductIdGet Vendor Orders By Product Id
Entrée
productIdstringrequispagenumberrequispar défaut
1limitnumberrequispar défaut
20Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/products.listGenericLinksList Generic Links
Entrée
Aucune entrée.
Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/products.listList
Entrée
pagenumberrequispar défaut
0limitnumberrequispar défaut
10searchstringfacultatifactivebooleanfacultatifisBuyablebooleanfacultatifcategoryIdstringfacultatifvendorIdstringfacultatifpackagingTypeIdstringfacultatifsortBystringrequispar défaut
"createdAt"sortOrderenumrequis"asc" "desc" · par défaut "desc"Réponse
200 Succès. Le résultat est dans
result.data.json : objectitemsobject[]facultatifidstringfacultatifreferencestringfacultatifplenigoOfferIdanyfacultatifplenigoAccessRightUniqueIdanyfacultatifnamestringfacultatifdescriptionstringfacultatifpricenumberfacultatifsalePriceintegerfacultatifproPriceanyfacultatifpurchasePriceintegerfacultatifstockintegerfacultatifstockLedgerintegerfacultatifisBuyablebooleanfacultatifskustringfacultatifisGenericbooleanfacultatifmagazineEditionIdanyfacultatifsiteIdstringfacultatifproductTypestringfacultatifmanageStockbooleanfacultatiflowStockThresholdanyfacultatifsoldIndividuallybooleanfacultatifweightanyfacultatiflengthanyfacultatifwidthanyfacultatifheightanyfacultatifpurchaseNoteanyfacultatifmenuOrderanyfacultatifdataobjectfacultatiflastSyncstringfacultatifprestashop_idstringfacultatifreferenceUnitstringfacultatifprestashop_dataobjectfacultatifmpnstringfacultatifupcstringfacultatifisbnanyfacultatifnamestringfacultatifrateintegerfacultatifdepthstringfacultatifean13stringfacultatifpricestringfacultatifstatestringfacultatifunitystringfacultatifwidthstringfacultatifactivestringfacultatifecotaxstringfacultatifheightstringfacultatifweightstringfacultatifid_langstringfacultatifid_shopstringfacultatifindexedstringfacultatifon_salestringfacultatifdate_addstringfacultatifdate_updstringfacultatiflocationstringfacultatifquantitystringfacultatiftax_namestringfacultatifconditionstringfacultatifreferencestringfacultatifid_productstringfacultatifis_virtualstringfacultatifmeta_titlestringfacultatifshow_pricestringfacultatifvisibilitystringfacultatifdescriptionstringfacultatiffinal_pricestringfacultatifid_supplierstringfacultatifonline_onlystringfacultatiftext_fieldsstringfacultatifcustomizablestringfacultatiflink_rewritestringfacultatifout_of_stockstringfacultatifproduct_typestringfacultatifavailable_nowstringfacultatifcache_is_packstringfacultatifmeta_keywordsstringfacultatifredirect_typestringfacultatifsupplier_nameanyfacultatifavailable_datestringfacultatifshow_conditionstringfacultatifavailable_laterstringfacultatifid_manufacturerstringfacultatifid_shop_defaultstringfacultatiflow_stock_alertstringfacultatifpack_stock_typestringfacultatifwholesale_pricestringfacultatifmeta_descriptionstringfacultatifminimal_quantitystringfacultatifunit_price_ratiostringfacultatifuploadable_filesstringfacultatifbundle_componentsany[]facultatifdelivery_in_stockanyfacultatifdescription_shortstringfacultatiflinked_categoriesobject[]facultatifmanufacturer_nameanyfacultatifquantity_discountstringfacultatifdelivery_out_stockanyfacultatifid_tax_rules_groupstringfacultatifid_type_redirectedstringfacultatifsupplier_referencestringfacultatifavailable_for_orderstringfacultatifid_category_defaultstringfacultatiflow_stock_thresholdanyfacultatifcache_has_attachmentsstringfacultatifcache_default_attributestringfacultatifadditional_shipping_coststringfacultatifadditional_delivery_timesstringfacultatifadvanced_stock_managementstringfacultatifreferenceSaleQuantityintegerfacultatifreferencePurchaseQuantityintegerfacultatifmanufacturerstringfacultatiftaxRatenumberfacultatifactivebooleanfacultatifdefaultVendorIdstringfacultatifpackagingTypeIdstringfacultatifpackagingQuantityintegerfacultatifpackagingUnitstringfacultatifsaleDetailstringfacultatifsaleQuantityintegerfacultatifsaleUnitstringfacultatifsaleTypestringfacultatifdefaultTemplateIdanyfacultatifapprovisionnementintegerfacultatifweightUnitanyfacultatifrequiresLotNumberbooleanfacultatifshowOrderDetailsbooleanfacultatifisPerishablebooleanfacultatifperishabilityDaysanyfacultatifdeliveryDaysanyfacultatifspecificOveragePercentanyfacultatifcreatedByIdstringfacultatifwarehouseIdanyfacultatifexternalIdstringfacultatifsyncedAtstringfacultatiflastSyncedAtanyfacultatifsourcestringfacultatifmainImageIdanyfacultatifcreatedAtstringfacultatifupdatedAtstringfacultatiftenantIdstringfacultatiftagsIdanyfacultatifisMaterialbooleanfacultatifisFinishedProductbooleanfacultatifmanufacturingLeadTimeanyfacultatifsafetyStockanyfacultatifreorderPointanyfacultatifmoqanyfacultatifmanufacturingCostanyfacultatifsubscriptionEnabledbooleanfacultatifsubscriptionDurationDaysanyfacultatifstripeProductIdanyfacultatifstripePriceIdanyfacultatifstripeRecurringPriceIdanyfacultatifmainImageanyfacultatifpackagingTypeobjectfacultatifidstringfacultatifnamestringfacultatifsizestringfacultatiforderByQuantityanyfacultatifdescriptionstringfacultatifcreatedAtstringfacultatifupdatedAtstringfacultatiftenantIdstringfacultatifdefaultVendorobjectfacultatifidstringfacultatifnamestringfacultatifassignedSubCategoriesany[]facultatifvariantsany[]facultatifeffectivePricenumberfacultatifpriceLabelstringfacultatiftotalintegerfacultatifpageintegerfacultatiflimitintegerfacultatifpagesintegerfacultatifEssayer
POST/api/trpc/products.removeSubCategoryFromProductRemove Sub Category From Product
Entrée
productIdstring · uuidrequissubCategoryIdstring · uuidrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/products.syncIndividualProductSync Individual Product
Entrée
productIdstring · uuidrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/products.syncProductsSync Products
Entrée
offsetnumberrequispar défaut
0limitnumberrequispar défaut
100Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/products.syncProductsStockSync Products Stock
Entrée
Aucune entrée.
Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/products.syncSingleProductStockSync Single Product Stock
Entrée
productIdstringrequisexternalIdstringfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/products.updateUpdate
Entrée
namestringfacultatif≥ 2 car.
descriptionstringfacultatifpricenumberfacultatif≥ 0
proPricenumber | nullfacultatifreferencestringfacultatifmanufacturerstringfacultatiftaxRatenumberfacultatif0–100
defaultVendorIdstringfacultatifpackagingTypeIdstringfacultatifpackagingQuantitynumberfacultatif≥ > 0
packagingUnitstringfacultatifsaleDetailstringfacultatifsaleQuantitynumberfacultatif≥ > 0
saleUnitstringfacultatifsaleTypestringfacultatifdefaultTemplateIdstringfacultatifisBuyablebooleanfacultatifactivebooleanfacultatifmainImageIdstring | nullfacultatifproductTypeenumfacultatif"SIMPLE" "VARIABLE" "COMPOSITE" "FORMULE" "MENU"manageStockbooleanfacultatifstockintegerfacultatif0–9007199254740991
lowStockThresholdintegerfacultatif0–9007199254740991
soldIndividuallybooleanfacultatifweightUnitstringfacultatifrequiresLotNumberbooleanfacultatifshowOrderDetailsbooleanfacultatifisPerishablebooleanfacultatifperishabilityDaysintegerfacultatif1–365
deliveryDaysintegerfacultatif1–30
specificOveragePercentintegerfacultatif0–100
weightnumberfacultatif≥ 0
lengthnumberfacultatif≥ > 0
widthnumberfacultatif≥ > 0
heightnumberfacultatif≥ > 0
purchaseNotestringfacultatifmenuOrderintegerfacultatif-9007199254740991–9007199254740991
isGenericbooleanfacultatifidstring · uuidrequisskipIndexingbooleanrequispar défaut
falseimagesstring[]facultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/products.updateStripeLinkUpdate Stripe Link
Entrée
idstring · uuidrequisstripeProductIdstring | nullfacultatifstripePriceIdstring | nullfacultatifstripeRecurringPriceIdstring | nullfacultatifsubscriptionEnabledbooleanfacultatifsubscriptionDurationDaysinteger | nullfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/products.updateWithAllNeedsUpdate With All Needs
Entrée
Aucune entrée.
Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/products.upsertGenericLinkUpsert Generic Link
Entrée
idstring · uuidfacultatifgenericProductIdstring · uuidrequisexternalProductIdstringrequis≥ 1 car.
conversionFactornumberrequis≥ > 0
conversionUnitstringfacultatif≥ 1 car. · par défaut
"kg"notesstringfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
recurringInvoices 10
POST/api/trpc/recurringInvoices.cancelCancel
Entrée
idstring · uuidrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/recurringInvoices.createCreate
Entrée
clientIdstring · uuidrequisfrequencyenumrequis"WEEKLY" "BIWEEKLY" "MONTHLY" "QUARTERLY" "YEARLY"startDateanyrequisendDateany | nullfacultatifitemsobject[]requis≥ 1 élém.
namestringrequis≥ 1 car.
descriptionstringfacultatifquantitynumberrequis≥ 1
unitPricenumberrequis≥ 0
taxRatenumberfacultatif0–1
currencystringrequis3–3 car. · par défaut
"EUR"languagestringrequis2–2 car. · par défaut
"fr"notesstringfacultatiffooterstringfacultatifpaymentTermsstringfacultatifpaymentMethodstringfacultatifautoSendbooleanrequispar défaut
falseautoReminderbooleanrequispar défaut
falsepdfTemplatenumberrequis1–5 · par défaut
3pdfFormatstringfacultatiftaxDetailsobjectfacultatifdiscountDetailsobjectfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/recurringInvoices.deleteDelete
Entrée
idstring · uuidrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
GET/api/trpc/recurringInvoices.getGet
Entrée
idstring · uuidrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
GET/api/trpc/recurringInvoices.getStatsGet Stats
Entrée
Aucune entrée.
Réponse
200 Succès. Le résultat est dans
result.data.json : objecttotalintegerfacultatifactiveintegerfacultatifpausedintegerfacultatifcancelledintegerfacultatifEssayer
GET/api/trpc/recurringInvoices.getUpcomingGet Upcoming
Entrée
daysAheadnumberrequis1–365 · par défaut
30Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/recurringInvoices.listList
Entrée
pagenumberrequis≥ 1 · par défaut
1limitnumberrequis1–100 · par défaut
20statusenumfacultatif"ACTIVE" "PAUSED" "CANCELLED" "COMPLETED"clientIdstring · uuidfacultatifsearchstringfacultatifRéponse
200 Succès. Le résultat est dans
result.data.json : objectitemsany[]facultatiftotalintegerfacultatifpageintegerfacultatiflimitintegerfacultatiftotalPagesintegerfacultatifhasMorebooleanfacultatifEssayer
POST/api/trpc/recurringInvoices.pausePause
Entrée
idstring · uuidrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/recurringInvoices.resumeResume
Entrée
idstring · uuidrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/recurringInvoices.updateUpdate
Entrée
idstring · uuidrequisclientIdstring · uuidfacultatiffrequencyenumfacultatif"WEEKLY" "BIWEEKLY" "MONTHLY" "QUARTERLY" "YEARLY"startDateanyfacultatifendDateany | nullfacultatifitemsobject[]facultatif≥ 1 élém.
namestringrequis≥ 1 car.
descriptionstringfacultatifquantitynumberrequis≥ 1
unitPricenumberrequis≥ 0
taxRatenumberfacultatif0–1
currencystringfacultatif3–3 car.
languagestringfacultatif2–2 car.
notesstringfacultatiffooterstringfacultatifpaymentTermsstringfacultatifpaymentMethodstringfacultatifautoSendbooleanfacultatifautoReminderbooleanfacultatifpdfTemplatenumberfacultatif1–5
pdfFormatstringfacultatiftaxDetailsobjectfacultatifdiscountDetailsobjectfacultatifstatusenumfacultatif"ACTIVE" "PAUSED" "CANCELLED" "COMPLETED"isActivebooleanfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
shipping 43
GET/api/trpc/shipping.calculateEUVATCalculate EUVAT
Entrée
amountnumberrequis≥ 0
fromCountrystringrequis2–2 car.
toCountrystringrequis2–2 car.
Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/shipping.calculateShippingRatesCalculate Shipping Rates
Entrée
originobjectrequispostalCodestringrequiscountrystringrequis2–2 car.
destinationobjectrequispostalCodestringrequiscountrystringrequis2–2 car.
packagesobject[]requisweightnumberrequis≥ > 0
lengthnumberfacultatif≥ > 0
widthnumberfacultatif≥ > 0
heightnumberfacultatif≥ > 0
currencystringrequis3–3 car.
carrierIdsstring · uuid[]facultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/shipping.colissimoCreateLabelColissimo Create Label
Entrée
shipmentIdstring · uuidrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
GET/api/trpc/shipping.colissimoGetRatesColissimo Get Rates
Entrée
originobjectrequispostalCodestringrequiscountrystringrequis2–2 car.
destinationobjectrequispostalCodestringrequiscountrystringrequis2–2 car.
weightnumberrequis≥ > 0
Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/shipping.colissimoSearchPickupPointsColissimo Search Pickup Points
Entrée
addressstringrequispostalCodestringrequiscitystringrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/shipping.colissimoTrackShipmentColissimo Track Shipment
Entrée
trackingNumberstringrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/shipping.createRateCreate Rate
Entrée
carrierIdstring · uuidrequisserviceIdstring · uuidrequiszoneIdstring · uuidrequisnamestringfacultatiftypeenumrequis"FLAT_RATE" "WEIGHT_BASED" "VOLUME_BASED" "DISTANCE_BASED" "HYBRID"weightMinnumberrequis≥ 0
weightMaxnumberrequis≥ > 0
baseRatenumberrequis≥ 0
perKgRatenumberfacultatif≥ 0
volumeMinnumberfacultatif≥ 0
volumeMaxnumberfacultatif≥ > 0
perVolumeRatenumberfacultatif≥ 0
handlingFeenumberfacultatif≥ 0
fuelSurchargenumberfacultatif0–100
insuranceFeenumberfacultatif≥ 0
corsicaSurchargenumberfacultatif≥ 0
domTomSurchargenumberfacultatif≥ 0
ruralSurchargenumberfacultatif≥ 0
pickupPointDiscountnumberfacultatif≥ 0
vatRatenumberrequis0–100
vatIncludedbooleanrequisisActivebooleanrequisvalidFromanyfacultatifvalidToanyfacultatifminOrderValuenumberfacultatif≥ 0
maxOrderValuenumberfacultatif≥ > 0
Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/shipping.createServiceCreate Service
Entrée
carrierIdstring · uuidrequisnamestringrequis≥ 1 car.
codestringrequis≥ 1 car.
typeenumrequis"STANDARD" "EXPRESS" "ECONOMY" "PICKUP_POINT" "SAME_DAY" "APPOINTMENT"descriptionstringfacultatifestimatedDaysMinintegerrequis1–9007199254740991
estimatedDaysMaxintegerrequis1–9007199254740991
trackingIncludedbooleanrequisinsuranceIncludedbooleanrequissignatureRequiredbooleanrequisisActivebooleanrequisavailableZonesstring[]requispickupPointServicebooleanrequisappointmentRequiredbooleanrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/shipping.createShipmentCreate Shipment
Entrée
orderIdstring · uuidrequiscarrierIdstring · uuidrequisserviceIdstring · uuidrequispickupPointIdstring · uuidfacultatifpackagesobject[]requisweightnumberrequis≥ > 0
lengthnumberfacultatif≥ > 0
widthnumberfacultatif≥ > 0
heightnumberfacultatif≥ > 0
senderAddressobjectrequisrecipientAddressobjectrequiscurrencystringrequis3–3 car.
instructionsstringfacultatifrequiresSignaturebooleanrequispar défaut
falseinsuranceValuenumberfacultatif≥ 0
Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/shipping.createShippingCarrierCreate Shipping Carrier
Entrée
namestringrequis≥ 1 car.
codestringrequis≥ 1 car.
descriptionstringfacultatiflogoUrlstring · urifacultatifwebsiteUrlstring · urifacultatifstatusenumrequis"ACTIVE" "INACTIVE" "TESTING" "SUSPENDED"priorityintegerrequis0–9007199254740991
apiEndpointstring · urifacultatifapiKeystringfacultatifapiSecretstringfacultatiftestModebooleanrequiscountryCodestringrequis2–2 car.
euCoveragebooleanrequisinternationalCoveragebooleanrequispickupPointsSupportedbooleanrequistrackingSupportedbooleanrequislabelGenerationSupportedbooleanrequiscorsicaSupportedbooleanrequisdomTomSupportedbooleanrequisappointmentDeliverybooleanrequismaxWeightnumberfacultatif≥ > 0
maxLengthnumberfacultatif≥ > 0
maxWidthnumberfacultatif≥ > 0
maxHeightnumberfacultatif≥ > 0
Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/shipping.createZoneCreate Zone
Entrée
namestringrequis≥ 1 car.
codestringrequis≥ 1 car.
typeenumrequis"DOMESTIC" "CORSICA" "DOM_TOM" "EU" "EUROPE_NON_EU" "INTERNATIONAL"descriptionstringfacultatifcountriesstring[]requisregionsstring[]requispostalCodeRangesobjectfacultatifincludesCorsicabooleanrequisincludesDomTombooleanrequisruralDeliveryHandlingbooleanrequisisActivebooleanrequispriorityintegerrequis0–9007199254740991
freeShippingThresholdnumberfacultatif≥ 0
maxWeightnumberfacultatif≥ > 0
maxDimensionsobjectfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/shipping.deleteRateDelete Rate
Entrée
rateIdstring · uuidrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/shipping.deleteServiceDelete Service
Entrée
serviceIdstring · uuidrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/shipping.deleteShippingCarrierDelete Shipping Carrier
Entrée
carrierIdstring · uuidrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/shipping.deleteZoneDelete Zone
Entrée
zoneIdstring · uuidrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/shipping.generateBulkLabelsGenerate Bulk Labels
Entrée
shipmentIdsstring · uuid[]requisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/shipping.generateLabelGenerate Label
Entrée
shipmentIdstring · uuidrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
GET/api/trpc/shipping.getCarrierGet Carrier
Entrée
Aucune entrée.
Réponse
200 Succès. Le résultat est dans
result.data.json : object[]idstringfacultatifcarrierIdstringfacultatiftenantIdstringfacultatifsiteIdstringfacultatifnamestringfacultatifcodestringfacultatiftypestringfacultatifdescriptionstringfacultatifestimatedDaysMinintegerfacultatifestimatedDaysMaxintegerfacultatiftrackingIncludedbooleanfacultatifinsuranceIncludedbooleanfacultatifsignatureRequiredbooleanfacultatifisActivebooleanfacultatifavailableZonesstring[]facultatifpickupPointServicebooleanfacultatifappointmentRequiredbooleanfacultatifcreatedAtstringfacultatifupdatedAtstringfacultatifcarrierobjectfacultatifidstringfacultatifnamestringfacultatifcodestringfacultatifratesobject[]facultatifidstringfacultatiftenantIdstringfacultatifsiteIdstringfacultatifcarrierIdstringfacultatifserviceIdstringfacultatifzoneIdstringfacultatifnamestringfacultatiftypestringfacultatifweightMinstringfacultatifweightMaxstringfacultatifbaseRatestringfacultatifperKgRatestringfacultatifvolumeMinanyfacultatifvolumeMaxanyfacultatifperVolumeRateanyfacultatifhandlingFeestringfacultatiffuelSurchargestringfacultatifinsuranceFeestringfacultatifcorsicaSurchargestringfacultatifdomTomSurchargestringfacultatifruralSurchargestringfacultatifpickupPointDiscountstringfacultatifvatRatestringfacultatifvatIncludedbooleanfacultatifisActivebooleanfacultatifvalidFromstringfacultatifvalidToanyfacultatifminOrderValuestringfacultatifmaxOrderValueanyfacultatifcreatedAtstringfacultatifupdatedAtstringfacultatifzoneobjectfacultatifidstringfacultatiftenantIdstringfacultatifsiteIdstringfacultatifnamestringfacultatifcodestringfacultatiftypestringfacultatifdescriptionstringfacultatifcountriesstring[]facultatifregionsany[]facultatifpostalCodeRangesanyfacultatifincludesCorsicabooleanfacultatifincludesDomTombooleanfacultatifruralDeliveryHandlingbooleanfacultatifisActivebooleanfacultatifpriorityintegerfacultatiffreeShippingThresholdstringfacultatifmaxWeightstringfacultatifmaxDimensionsanyfacultatifcreatedAtstringfacultatifupdatedAtstringfacultatifEssayer
GET/api/trpc/shipping.getCostAnalysisGet Cost Analysis
Entrée
startDateanyrequisendDateanyrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/shipping.getDeliveryPerformanceGet Delivery Performance
Entrée
startDateanyrequisendDateanyrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/shipping.getPerformanceDashboardGet Performance Dashboard
Entrée
startDateanyrequisendDateanyrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/shipping.getPickupPointsGet Pickup Points
Entrée
carrierIdstring · uuidrequisaddressstringrequispostalCodestringrequiscitystringrequiscountrystringrequis2–2 car.
Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
GET/api/trpc/shipping.getPrintJobsGet Print Jobs
Entrée
pageintegerrequis1–9007199254740991 · par défaut
1limitintegerrequis1–100 · par défaut
50Réponse
200 Succès. Le résultat est dans
result.data.json : objectsuccessbooleanfacultatifprintJobsany[]facultatiftotalintegerfacultatifhasMorebooleanfacultatifEssayer
GET/api/trpc/shipping.getQuickEstimateGet Quick Estimate
Entrée
weightnumberrequis≥ > 0
carrierIdstring · uuidfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/shipping.getRatesGet Rates
Entrée
Aucune entrée.
Réponse
200 Succès. Le résultat est dans
result.data.json : object[]idstringfacultatiftenantIdstringfacultatifsiteIdstringfacultatifcarrierIdstringfacultatifserviceIdstringfacultatifzoneIdstringfacultatifnamestringfacultatiftypestringfacultatifweightMinstringfacultatifweightMaxstringfacultatifbaseRatestringfacultatifperKgRatestringfacultatifvolumeMinanyfacultatifvolumeMaxanyfacultatifperVolumeRateanyfacultatifhandlingFeestringfacultatiffuelSurchargestringfacultatifinsuranceFeestringfacultatifcorsicaSurchargestringfacultatifdomTomSurchargestringfacultatifruralSurchargestringfacultatifpickupPointDiscountstringfacultatifvatRatestringfacultatifvatIncludedbooleanfacultatifisActivebooleanfacultatifvalidFromstringfacultatifvalidToanyfacultatifminOrderValuestringfacultatifmaxOrderValueanyfacultatifcreatedAtstringfacultatifupdatedAtstringfacultatifzoneobjectfacultatifidstringfacultatifnamestringfacultatifcountriesstring[]facultatifserviceobjectfacultatifidstringfacultatifnamestringfacultatiftypestringfacultatifcarrierobjectfacultatifidstringfacultatifnamestringfacultatifEssayer
GET/api/trpc/shipping.getShipmentGet Shipment
Entrée
shipmentIdstring · uuidrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
GET/api/trpc/shipping.getShipmentsGet Shipments
Entrée
pageintegerrequis1–9007199254740991 · par défaut
1limitintegerrequis1–100 · par défaut
20statusstringfacultatifcarrierIdstring · uuidfacultatifdateFromanyfacultatifdateToanyfacultatifsearchstringfacultatifRéponse
200 Succès. Le résultat est dans
result.data.json : objectshipmentsany[]facultatiftotalintegerfacultatifpageintegerfacultatiflimitintegerfacultatifhasMorebooleanfacultatifEssayer
GET/api/trpc/shipping.getShippingAnalyticsGet Shipping Analytics
Entrée
startDateanyrequisendDateanyrequiscarrierIdstring · uuidfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/shipping.getShippingCarriersGet Shipping Carriers
Entrée
includeInactivebooleanrequispar défaut
falseRéponse
200 Succès. Le résultat est dans
result.data.json : object[]idstringfacultatiftenantIdstringfacultatifsiteIdstringfacultatifnamestringfacultatifcodestringfacultatifdescriptionstringfacultatiflogoUrlanyfacultatifwebsiteUrlanyfacultatifstatusstringfacultatifpriorityintegerfacultatifapiEndpointanyfacultatifapiKeyanyfacultatifapiSecretanyfacultatiftestModebooleanfacultatifcountryCodestringfacultatifeuCoveragebooleanfacultatifinternationalCoveragebooleanfacultatifpickupPointsSupportedbooleanfacultatiftrackingSupportedbooleanfacultatiflabelGenerationSupportedbooleanfacultatifcorsicaSupportedbooleanfacultatifdomTomSupportedbooleanfacultatifappointmentDeliverybooleanfacultatifmaxWeightstringfacultatifmaxLengthanyfacultatifmaxWidthanyfacultatifmaxHeightanyfacultatifcreatedAtstringfacultatifupdatedAtstringfacultatifservicesobject[]facultatifidstringfacultatifnamestringfacultatiftypestringfacultatifEssayer
GET/api/trpc/shipping.getShippingConfigurationGet Shipping Configuration
Entrée
includeInactivebooleanrequispar défaut
falseRéponse
200 Succès. Le résultat est dans
result.data.json : object[]idstringfacultatiftenantIdstringfacultatifsiteIdstringfacultatifnamestringfacultatifcodestringfacultatifdescriptionstringfacultatiflogoUrlanyfacultatifwebsiteUrlanyfacultatifstatusstringfacultatifpriorityintegerfacultatifapiEndpointanyfacultatifapiKeyanyfacultatifapiSecretanyfacultatiftestModebooleanfacultatifcountryCodestringfacultatifeuCoveragebooleanfacultatifinternationalCoveragebooleanfacultatifpickupPointsSupportedbooleanfacultatiftrackingSupportedbooleanfacultatiflabelGenerationSupportedbooleanfacultatifcorsicaSupportedbooleanfacultatifdomTomSupportedbooleanfacultatifappointmentDeliverybooleanfacultatifmaxWeightstringfacultatifmaxLengthanyfacultatifmaxWidthanyfacultatifmaxHeightanyfacultatifcreatedAtstringfacultatifupdatedAtstringfacultatifservicesobject[]facultatifidstringfacultatifnamestringfacultatiftypestringfacultatifEssayer
GET/api/trpc/shipping.getShippingZonesGet Shipping Zones
Entrée
Aucune entrée.
Réponse
200 Succès. Le résultat est dans
result.data.json : object[]idstringfacultatiftenantIdstringfacultatifsiteIdstringfacultatifnamestringfacultatifcodestringfacultatiftypestringfacultatifdescriptionstringfacultatifcountriesstring[]facultatifregionsany[]facultatifpostalCodeRangesanyfacultatifincludesCorsicabooleanfacultatifincludesDomTombooleanfacultatifruralDeliveryHandlingbooleanfacultatifisActivebooleanfacultatifpriorityintegerfacultatiffreeShippingThresholdstringfacultatifmaxWeightstringfacultatifmaxDimensionsanyfacultatifcreatedAtstringfacultatifupdatedAtstringfacultatif_countobjectfacultatifratesintegerfacultatifEssayer
GET/api/trpc/shipping.getZonesGet Zones
Entrée
Aucune entrée.
Réponse
200 Succès. Le résultat est dans
result.data.json : object[]idstringfacultatiftenantIdstringfacultatifsiteIdstringfacultatifnamestringfacultatifcodestringfacultatiftypestringfacultatifdescriptionstringfacultatifcountriesstring[]facultatifregionsany[]facultatifpostalCodeRangesanyfacultatifincludesCorsicabooleanfacultatifincludesDomTombooleanfacultatifruralDeliveryHandlingbooleanfacultatifisActivebooleanfacultatifpriorityintegerfacultatiffreeShippingThresholdstringfacultatifmaxWeightstringfacultatifmaxDimensionsanyfacultatifcreatedAtstringfacultatifupdatedAtstringfacultatif_countobjectfacultatifratesintegerfacultatifEssayer
GET/api/trpc/shipping.performComplianceCheckPerform Compliance Check
Entrée
shipmentIdstring · uuidrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/shipping.processBulkOrdersProcess Bulk Orders
Entrée
orderIdsstring · uuid[]requisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/shipping.searchPickupPointsSearch Pickup Points
Entrée
siteSlugstringrequisaddressstringrequismaxResultsintegerrequis1–20 · par défaut
10Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/shipping.sendShippingNotificationSend Shipping Notification
Entrée
shipmentIdstring · uuidrequistypeenumrequis"CREATED" "SHIPPED" "IN_TRANSIT" "DELIVERED" "EXCEPTION"Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/shipping.updateCarrierRatesUpdate Carrier Rates
Entrée
carrierIdstring · uuidrequisratesobject[]requiscarrierIdstring · uuidrequisserviceIdstring · uuidrequiszoneIdstring · uuidrequisnamestringfacultatiftypeenumrequis"FLAT_RATE" "WEIGHT_BASED" "VOLUME_BASED" "DISTANCE_BASED" "HYBRID"weightMinnumberrequis≥ 0
weightMaxnumberrequis≥ > 0
baseRatenumberrequis≥ 0
perKgRatenumberfacultatif≥ 0
volumeMinnumberfacultatif≥ 0
volumeMaxnumberfacultatif≥ > 0
perVolumeRatenumberfacultatif≥ 0
handlingFeenumberfacultatif≥ 0
fuelSurchargenumberfacultatif0–100
insuranceFeenumberfacultatif≥ 0
corsicaSurchargenumberfacultatif≥ 0
domTomSurchargenumberfacultatif≥ 0
ruralSurchargenumberfacultatif≥ 0
pickupPointDiscountnumberfacultatif≥ 0
vatRatenumberrequis0–100
vatIncludedbooleanrequisisActivebooleanrequisvalidFromanyfacultatifvalidToanyfacultatifminOrderValuenumberfacultatif≥ 0
maxOrderValuenumberfacultatif≥ > 0
Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/shipping.updateRateUpdate Rate
Entrée
carrierIdstring · uuidfacultatifserviceIdstring · uuidfacultatifzoneIdstring · uuidfacultatifnamestringfacultatiftypeenumfacultatif"FLAT_RATE" "WEIGHT_BASED" "VOLUME_BASED" "DISTANCE_BASED" "HYBRID"weightMinnumberfacultatif≥ 0
weightMaxnumberfacultatif≥ > 0
baseRatenumberfacultatif≥ 0
perKgRatenumberfacultatif≥ 0
volumeMinnumberfacultatif≥ 0
volumeMaxnumberfacultatif≥ > 0
perVolumeRatenumberfacultatif≥ 0
handlingFeenumberfacultatif≥ 0
fuelSurchargenumberfacultatif0–100
insuranceFeenumberfacultatif≥ 0
corsicaSurchargenumberfacultatif≥ 0
domTomSurchargenumberfacultatif≥ 0
ruralSurchargenumberfacultatif≥ 0
pickupPointDiscountnumberfacultatif≥ 0
vatRatenumberfacultatif0–100
vatIncludedbooleanfacultatifisActivebooleanfacultatifvalidFromanyfacultatifvalidToanyfacultatifminOrderValuenumberfacultatif≥ 0
maxOrderValuenumberfacultatif≥ > 0
rateIdstring · uuidrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/shipping.updateServiceUpdate Service
Entrée
carrierIdstring · uuidfacultatifnamestringfacultatif≥ 1 car.
codestringfacultatif≥ 1 car.
typeenumfacultatif"STANDARD" "EXPRESS" "ECONOMY" "PICKUP_POINT" "SAME_DAY" "APPOINTMENT"descriptionstringfacultatifestimatedDaysMinintegerfacultatif1–9007199254740991
estimatedDaysMaxintegerfacultatif1–9007199254740991
trackingIncludedbooleanfacultatifinsuranceIncludedbooleanfacultatifsignatureRequiredbooleanfacultatifisActivebooleanfacultatifavailableZonesstring[]facultatifpickupPointServicebooleanfacultatifappointmentRequiredbooleanfacultatifserviceIdstring · uuidrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/shipping.updateShippingCarrierUpdate Shipping Carrier
Entrée
namestringfacultatif≥ 1 car.
codestringfacultatif≥ 1 car.
descriptionstringfacultatiflogoUrlstring · urifacultatifwebsiteUrlstring · urifacultatifstatusenumfacultatif"ACTIVE" "INACTIVE" "TESTING" "SUSPENDED"priorityintegerfacultatif0–9007199254740991
apiEndpointstring · urifacultatifapiKeystringfacultatifapiSecretstringfacultatiftestModebooleanfacultatifcountryCodestringfacultatif2–2 car.
euCoveragebooleanfacultatifinternationalCoveragebooleanfacultatifpickupPointsSupportedbooleanfacultatiftrackingSupportedbooleanfacultatiflabelGenerationSupportedbooleanfacultatifcorsicaSupportedbooleanfacultatifdomTomSupportedbooleanfacultatifappointmentDeliverybooleanfacultatifmaxWeightnumberfacultatif≥ > 0
maxLengthnumberfacultatif≥ > 0
maxWidthnumberfacultatif≥ > 0
maxHeightnumberfacultatif≥ > 0
carrierIdstring · uuidrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/shipping.updateZoneUpdate Zone
Entrée
namestringfacultatif≥ 1 car.
codestringfacultatif≥ 1 car.
typeenumfacultatif"DOMESTIC" "CORSICA" "DOM_TOM" "EU" "EUROPE_NON_EU" "INTERNATIONAL"descriptionstringfacultatifcountriesstring[]facultatifregionsstring[]facultatifpostalCodeRangesobjectfacultatifincludesCorsicabooleanfacultatifincludesDomTombooleanfacultatifruralDeliveryHandlingbooleanfacultatifisActivebooleanfacultatifpriorityintegerfacultatif0–9007199254740991
freeShippingThresholdnumberfacultatif≥ 0
maxWeightnumberfacultatif≥ > 0
maxDimensionsobjectfacultatifzoneIdstring · uuidrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
GET/api/trpc/shipping.validateAddressValidate Address
Entrée
addressobjectrequisstreetstringrequiscitystringrequispostalCodestringrequiscountrystringrequis2–2 car.
Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/shipping.validateCarrierAPIValidate Carrier API
Entrée
carrierIdstring · uuidrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
subscriptions 2
GET/api/trpc/subscriptions.cancelCancel
Entrée
subscriptionIdstring · uuidrequisnewAmountnumberrequis≥ > 0
Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/subscriptions.createCreate
Entrée
Aucune entrée.
Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
tiers 29
GET/api/trpc/tiers.checkTiersExistenceCheck Tiers Existence
Entrée
criteriaobjectrequissiretstringfacultatifsirenstringfacultatifemailstring · emailfacultatifnamestringfacultatifRéponse
200 Succès. Le résultat est dans
result.data.json : objectexistsbooleanfacultatiftiersanyfacultatifmatchesany[]facultatifEssayer
POST/api/trpc/tiers.createActivityCreate Activity
Entrée
tiersIdstring · uuidrequistypeenumrequis"CALL" "EMAIL" "MEETING" "TASK" "NOTE" "DOCUMENT_SHARED" "QUOTE_SENT" "PROPOSAL_SENT" "CONTRACT_SIGNED" "PAYMENT_RECEIVED" …subjectstringrequis≥ 1 car.
descriptionstringfacultatifscheduledAtanyfacultatifcontactIdstring · uuidfacultatifopportunityIdstring · uuidfacultatifeventIdstring · uuidfacultatifpriorityenumrequis"LOW" "MEDIUM" "HIGH" "URGENT" · par défaut "MEDIUM"metadataobjectfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/tiers.createAddressCreate Address
Entrée
tiersIdstring · uuidrequistypeenumrequis"BILLING" "SHIPPING" "HEADQUARTERS" "BRANCH" · par défaut "BILLING"namestringfacultatifstreetstringrequis≥ 1 car.
street2stringfacultatifcitystringrequis≥ 1 car.
postalCodestringrequis≥ 1 car.
countrystringrequis2–2 car. · par défaut
"FR"regionstringfacultatiflatitudenumberfacultatiflongitudenumberfacultatifisDefaultbooleanrequispar défaut
falseisActivebooleanrequispar défaut
truemetadataobjectfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/tiers.createContactCreate Contact
Entrée
tiersIdstring · uuidrequisfirstNamestringrequis≥ 1 car.
lastNamestringrequis≥ 1 car.
emailstring · emailfacultatifphonestringfacultatifmobilestringfacultatifrolestringfacultatiftitlestringfacultatifdepartmentstringfacultatifisPrimarybooleanrequispar défaut
falsetagsstring[]facultatifmetadataobjectfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/tiers.createCustomFieldCreate Custom Field
Entrée
object
Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/tiers.createOpportunityCreate Opportunity
Entrée
tiersIdstring · uuidrequisnamestringrequis≥ 1 car.
descriptionstringfacultatifstatusenumfacultatif"LEAD" "QUALIFIED" "PROPOSAL" "NEGOTIATION" "CLOSED_WON" "CLOSED_LOST"sourceenumfacultatif"WEBSITE" "REFERRAL" "COLD_CALL" "EMAIL_CAMPAIGN" "SOCIAL_MEDIA" "TRADE_SHOW" "PARTNER" "OTHER"stagestringfacultatifvaluenumberfacultatif≥ > 0
probabilitynumberrequis0–100 · par défaut
0expectedCloseDateanyfacultatifprimaryContactIdstring · uuidfacultatifassignedToIdstring · uuidrequislostReasonstringfacultatifcompetitorInfostringfacultatifnextActionstringfacultatifnextActionDateanyfacultatifmetadataobjectfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/tiers.createTiersCreate Tiers
Entrée
namestringrequis≥ 1 car.
emailstring · emailfacultatifphonestringfacultatifsiretstringfacultatifsirenstringfacultatiftvastringfacultatiftypeenumrequis"CLIENT" "FOURNISSEUR" "PROSPECT" "PARTENAIRE" · par défaut "CLIENT"statusenumrequis"ACTIVE" "INACTIVE" "ARCHIVED" · par défaut "ACTIVE"industrystringfacultatifcompanySizestringfacultatifannualRevenuestringfacultatifwebsitestring · urifacultatifdescriptionstringfacultatifcreditLimitnumberfacultatif≥ 0
creditUsednumberfacultatif≥ 0
paymentTermsstringfacultatifpreferredCurrencyenumrequis"EUR" "USD" "GBP" · par défaut "EUR"taxExemptbooleanrequispar défaut
falsecreditScorenumberfacultatif0–1000
riskLevelenumfacultatif"LOW" "MEDIUM" "HIGH"tagsstring[]facultatifmetadataobjectfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/tiers.deleteTiersDelete Tiers
Entrée
idstring · uuidrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
GET/api/trpc/tiers.getActivitiesGet Activities
Entrée
tiersIdstring · uuidfacultatifcontactIdstring · uuidfacultatiftypeenum[]facultatifstatusenum[]facultatifpriorityenum[]facultatifdateFromanyfacultatifdateToanyfacultatifassignedToIdstring · uuidfacultatifpagenumberrequis≥ 1 · par défaut
1limitnumberrequis1–50 · par défaut
20sortByenumrequis"createdAt" "scheduledAt" "priority" "type" · par défaut "createdAt"sortOrderenumrequis"asc" "desc" · par défaut "desc"Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/tiers.getAllTiersGet All Tiers
Entrée
pagenumberrequis≥ 1 · par défaut
1limitnumberrequis1–100 · par défaut
20searchstringfacultatiftypeenumfacultatif"CLIENT" "FOURNISSEUR" "PROSPECT" "PARTENAIRE"statusenumfacultatif"ACTIVE" "INACTIVE" "ARCHIVED"sortByenumrequis"name" "createdAt" "updatedAt" · par défaut "name"sortOrderenumrequis"asc" "desc" · par défaut "asc"Réponse
200 Succès. Le résultat est dans
result.data.json : objecttiersobject[]facultatifidstringfacultatifnamestringfacultatifupdatedAtstringfacultatifcreatedAtstringfacultatifsyncedAtstringfacultatifsuperiorIdanyfacultatifrefstringfacultatifexternalIdstringfacultatifexternalRefstringfacultatifexternalRefComptableanyfacultatifdescriptionstringfacultatifnumSirenanyfacultatifnumSiretanyfacultatifnumTvaanyfacultatifcodeNafanyfacultatifcommercialanyfacultatifstatutstringfacultatifsourcestringfacultatifecheanceanyfacultatifmodeDePaiementanyfacultatifmainActivityanyfacultatifpaymentConditionIdanyfacultatifdeliveryCommentsanyfacultatifdate_creationstringfacultatifdate_dernier_appelTeleproanyfacultatifdate_dernier_appelCommercialanyfacultatifdate_dernier_rdvanyfacultatifdate_prochain_rdvanyfacultatifrdvPrisanyfacultatifribanyfacultatifextraDataobjectfacultatifemailstringfacultatifoptinbooleanfacultatifactivebooleanfacultatifid_langintegerfacultatifid_shopintegerfacultatifdate_addstringfacultatifdate_updstringfacultatiflastSyncstringfacultatiflastnamestringfacultatifaddressesany[]facultatiffirstnamestringfacultatifnewsletterbooleanfacultatifid_customerintegerfacultatifid_shop_groupintegerfacultatifgeocodeanyfacultatifaddressL1anyfacultatifaddressL2anyfacultatifaddressCPanyfacultatifaddressCommuneanyfacultatifaddressDepartementanyfacultatiflatitudeanyfacultatiflongitudeanyfacultatifuserIdstringfacultatifcreatedByIdstringfacultatifassignedToIdanyfacultatiftenantIdstringfacultatifsiteIdstringfacultatiflastSyncedAtanyfacultatifaccountManagerIdanyfacultatifannualRevenueanyfacultatifaverageOrderValuestringfacultatifcompanySizeanyfacultatifcreditCheckDateanyfacultatifcreditLimitanyfacultatifcreditScoreanyfacultatifcreditUsedstringfacultatiffirstOrderDateanyfacultatifindustryanyfacultatiflanguagestringfacultatiflastOrderDateanyfacultatiflastQualificationDateanyfacultatifleadScoreintegerfacultatiflifetimeValuestringfacultatifoutstandingBalancestringfacultatifparentCompanyIdanyfacultatifpartnerTypeanyfacultatifpaymentTermsanyfacultatifpreferredContactMethodstringfacultatifpreferredCurrencystringfacultatifqualificationNotesanyfacultatifqualificationStatusanyfacultatifsocialMediaUrlsanyfacultatiftaxExemptbooleanfacultatiftimezoneanyfacultatiftotalRevenuestringfacultatifwebsiteanyfacultatifcontactsany[]facultatiffinancialany[]facultatiftotalintegerfacultatifpageintegerfacultatiflimitintegerfacultatifhasMorebooleanfacultatifEssayer
GET/api/trpc/tiers.getFinancialsByTiersExternalIdsGet Financials By Tiers External Ids
Entrée
externalIdsstring[]requisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/tiers.getOpportunitiesGet Opportunities
Entrée
tiersIdstring · uuidfacultatifstatusenum[]facultatifstagestring[]facultatifassignedToIdstring · uuidfacultatifvalueMinnumberfacultatifvalueMaxnumberfacultatifprobabilityMinnumberfacultatifprobabilityMaxnumberfacultatifexpectedCloseFromanyfacultatifexpectedCloseToanyfacultatifpagenumberrequis≥ 1 · par défaut
1limitnumberrequis1–50 · par défaut
20sortByenumrequis"createdAt" "expectedCloseDate" "value" "probability" · par défaut "createdAt"sortOrderenumrequis"asc" "desc" · par défaut "desc"Réponse
200 Succès. Le résultat est dans
result.data.json : objectopportunitiesany[]facultatiftotalintegerfacultatifpageintegerfacultatiflimitintegerfacultatifhasMorebooleanfacultatifsummaryanyfacultatifEssayer
GET/api/trpc/tiers.getTiersActivitiesByIdGet Tiers Activities By Id
Entrée
idstring · uuidrequispagenumberrequis≥ 1 · par défaut
1limitnumberrequis1–50 · par défaut
20Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
GET/api/trpc/tiers.getTiersByIdGet Tiers By Id
Entrée
idstring · uuidrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
GET/api/trpc/tiers.getTiersByIdsGet Tiers By Ids
Entrée
idsstring · uuid[]requisRéponse
200 Succès. Le résultat est dans
result.data.json : objecttiersany[]facultatiftotalintegerfacultatifEssayer
GET/api/trpc/tiers.getTiersByRefGet Tiers By Ref
Entrée
refstringrequisRéponse
200 Succès. Le résultat est dans
result.data.json : objectidstringfacultatifnamestringfacultatifupdatedAtstringfacultatifcreatedAtstringfacultatifsyncedAtstringfacultatifsuperiorIdanyfacultatifrefstringfacultatifexternalIdstringfacultatifexternalRefstringfacultatifexternalRefComptableanyfacultatifdescriptionstringfacultatifnumSirenanyfacultatifnumSiretstringfacultatifnumTvastringfacultatifcodeNafanyfacultatifcommercialanyfacultatifstatutstringfacultatifsourcestringfacultatifecheanceanyfacultatifmodeDePaiementstringfacultatifmainActivitystringfacultatifpaymentConditionIdanyfacultatifdeliveryCommentsstringfacultatifdate_creationstringfacultatifdate_dernier_appelTeleproanyfacultatifdate_dernier_appelCommercialanyfacultatifdate_dernier_rdvanyfacultatifdate_prochain_rdvanyfacultatifrdvPrisanyfacultatifribanyfacultatifextraDataobjectfacultatifemailstringfacultatifoptinbooleanfacultatifactivebooleanfacultatifid_langintegerfacultatifid_shopintegerfacultatifdate_addstringfacultatifdate_updstringfacultatiflastSyncstringfacultatiflastnamestringfacultatifaddressesobject[]facultatifcitystringfacultatifphonestringfacultatifaddressstringfacultatifcountrystringfacultatifaddress2stringfacultatifpostcodestringfacultatifphone_mobilestringfacultatiffirstnamestringfacultatifnewsletterbooleanfacultatifid_customerintegerfacultatifid_shop_groupintegerfacultatifgeocodeanyfacultatifaddressL1stringfacultatifaddressL2stringfacultatifaddressCPstringfacultatifaddressCommunestringfacultatifaddressDepartementstringfacultatiflatitudeanyfacultatiflongitudeanyfacultatifuserIdstringfacultatifcreatedByIdstringfacultatifassignedToIdanyfacultatiftenantIdstringfacultatifsiteIdstringfacultatiflastSyncedAtanyfacultatifaccountManagerIdanyfacultatifannualRevenueanyfacultatifaverageOrderValuestringfacultatifcompanySizeanyfacultatifcreditCheckDateanyfacultatifcreditLimitanyfacultatifcreditScoreanyfacultatifcreditUsedstringfacultatiffirstOrderDateanyfacultatifindustryanyfacultatiflanguagestringfacultatiflastOrderDateanyfacultatiflastQualificationDateanyfacultatifleadScoreintegerfacultatiflifetimeValuestringfacultatifoutstandingBalancestringfacultatifparentCompanyIdanyfacultatifpartnerTypeanyfacultatifpaymentTermsanyfacultatifpreferredContactMethodstringfacultatifpreferredCurrencystringfacultatifqualificationNotesanyfacultatifqualificationStatusanyfacultatifsocialMediaUrlsanyfacultatiftaxExemptbooleanfacultatiftimezoneanyfacultatiftotalRevenuestringfacultatifwebsiteanyfacultatifcontactsany[]facultatifActivitiesany[]facultatifOpportunitiesany[]facultatiffinancialany[]facultatifDocumentsany[]facultatifEssayer
GET/api/trpc/tiers.getTiersBySiretGet Tiers By Siret
Entrée
siretstringrequisRéponse
200 Succès. Le résultat est dans
result.data.json : objectidstringfacultatifnamestringfacultatifupdatedAtstringfacultatifcreatedAtstringfacultatifsyncedAtstringfacultatifsuperiorIdanyfacultatifrefstringfacultatifexternalIdstringfacultatifexternalRefstringfacultatifexternalRefComptableanyfacultatifdescriptionstringfacultatifnumSirenanyfacultatifnumSiretstringfacultatifnumTvastringfacultatifcodeNafanyfacultatifcommercialanyfacultatifstatutstringfacultatifsourcestringfacultatifecheanceanyfacultatifmodeDePaiementstringfacultatifmainActivitystringfacultatifpaymentConditionIdanyfacultatifdeliveryCommentsstringfacultatifdate_creationstringfacultatifdate_dernier_appelTeleproanyfacultatifdate_dernier_appelCommercialanyfacultatifdate_dernier_rdvanyfacultatifdate_prochain_rdvanyfacultatifrdvPrisanyfacultatifribanyfacultatifextraDataobjectfacultatifemailstringfacultatifoptinbooleanfacultatifactivebooleanfacultatifid_langintegerfacultatifid_shopintegerfacultatifdate_addstringfacultatifdate_updstringfacultatiflastSyncstringfacultatiflastnamestringfacultatifaddressesobject[]facultatifcitystringfacultatifphonestringfacultatifaddressstringfacultatifcountrystringfacultatifaddress2stringfacultatifpostcodestringfacultatifphone_mobilestringfacultatiffirstnamestringfacultatifnewsletterbooleanfacultatifid_customerintegerfacultatifid_shop_groupintegerfacultatifgeocodeanyfacultatifaddressL1stringfacultatifaddressL2stringfacultatifaddressCPstringfacultatifaddressCommunestringfacultatifaddressDepartementstringfacultatiflatitudeanyfacultatiflongitudeanyfacultatifuserIdstringfacultatifcreatedByIdstringfacultatifassignedToIdanyfacultatiftenantIdstringfacultatifsiteIdstringfacultatiflastSyncedAtanyfacultatifaccountManagerIdanyfacultatifannualRevenueanyfacultatifaverageOrderValuestringfacultatifcompanySizeanyfacultatifcreditCheckDateanyfacultatifcreditLimitanyfacultatifcreditScoreanyfacultatifcreditUsedstringfacultatiffirstOrderDateanyfacultatifindustryanyfacultatiflanguagestringfacultatiflastOrderDateanyfacultatiflastQualificationDateanyfacultatifleadScoreintegerfacultatiflifetimeValuestringfacultatifoutstandingBalancestringfacultatifparentCompanyIdanyfacultatifpartnerTypeanyfacultatifpaymentTermsanyfacultatifpreferredContactMethodstringfacultatifpreferredCurrencystringfacultatifqualificationNotesanyfacultatifqualificationStatusanyfacultatifsocialMediaUrlsanyfacultatiftaxExemptbooleanfacultatiftimezoneanyfacultatiftotalRevenuestringfacultatifwebsiteanyfacultatifEssayer
GET/api/trpc/tiers.getTiersContactsByIdGet Tiers Contacts By Id
Entrée
idstring · uuidrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
GET/api/trpc/tiers.getTiersEnhancedGet Tiers Enhanced
Entrée
idstring · uuidrequisincludeContactsbooleanrequispar défaut
trueincludeAddressesbooleanrequispar défaut
trueincludeActivitiesbooleanrequispar défaut
falseincludeOpportunitiesbooleanrequispar défaut
falseincludeFinancialsbooleanrequispar défaut
trueincludeFilesbooleanrequispar défaut
falseactivityLimitnumberrequis1–20 · par défaut
5opportunityLimitnumberrequis1–10 · par défaut
5Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
GET/api/trpc/tiers.getTiersFilesByIdGet Tiers Files By Id
Entrée
idstring · uuidrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
GET/api/trpc/tiers.getTiersGet Tiers
Entrée
pagenumberrequis≥ 1 · par défaut
1limitnumberrequis1–100 · par défaut
20searchstringfacultatiffiltersobjectfacultatiftypeenum[]facultatifstatusenum[]facultatifindustrystring[]facultatiftagsstring[]facultatifhasCreditbooleanfacultatifcreditRiskenumfacultatif"LOW" "MEDIUM" "HIGH"sortByenumrequis"name" "createdAt" "updatedAt" "creditScore" "totalRevenue" · par défaut "name"sortOrderenumrequis"asc" "desc" · par défaut "asc"includeContactsbooleanrequispar défaut
falseincludeFinancialsbooleanrequispar défaut
falseRéponse
200 Succès. Le résultat est dans
result.data.json : objecttiersobject[]facultatifidstringfacultatifnamestringfacultatifupdatedAtstringfacultatifcreatedAtstringfacultatifsyncedAtstringfacultatifsuperiorIdanyfacultatifrefstringfacultatifexternalIdstringfacultatifexternalRefstringfacultatifexternalRefComptableanyfacultatifdescriptionstringfacultatifnumSirenanyfacultatifnumSiretanyfacultatifnumTvaanyfacultatifcodeNafanyfacultatifcommercialanyfacultatifstatutstringfacultatifsourcestringfacultatifecheanceanyfacultatifmodeDePaiementanyfacultatifmainActivityanyfacultatifpaymentConditionIdanyfacultatifdeliveryCommentsanyfacultatifdate_creationstringfacultatifdate_dernier_appelTeleproanyfacultatifdate_dernier_appelCommercialanyfacultatifdate_dernier_rdvanyfacultatifdate_prochain_rdvanyfacultatifrdvPrisanyfacultatifribanyfacultatifextraDataobjectfacultatifemailstringfacultatifoptinbooleanfacultatifactivebooleanfacultatifid_langintegerfacultatifid_shopintegerfacultatifdate_addstringfacultatifdate_updstringfacultatiflastSyncstringfacultatiflastnamestringfacultatifaddressesany[]facultatiffirstnamestringfacultatifnewsletterbooleanfacultatifid_customerintegerfacultatifid_shop_groupintegerfacultatifgeocodeanyfacultatifaddressL1anyfacultatifaddressL2anyfacultatifaddressCPanyfacultatifaddressCommuneanyfacultatifaddressDepartementanyfacultatiflatitudeanyfacultatiflongitudeanyfacultatifuserIdstringfacultatifcreatedByIdstringfacultatifassignedToIdanyfacultatiftenantIdstringfacultatifsiteIdstringfacultatiflastSyncedAtanyfacultatifaccountManagerIdanyfacultatifannualRevenueanyfacultatifaverageOrderValuestringfacultatifcompanySizeanyfacultatifcreditCheckDateanyfacultatifcreditLimitanyfacultatifcreditScoreanyfacultatifcreditUsedstringfacultatiffirstOrderDateanyfacultatifindustryanyfacultatiflanguagestringfacultatiflastOrderDateanyfacultatiflastQualificationDateanyfacultatifleadScoreintegerfacultatiflifetimeValuestringfacultatifoutstandingBalancestringfacultatifparentCompanyIdanyfacultatifpartnerTypeanyfacultatifpaymentTermsanyfacultatifpreferredContactMethodstringfacultatifpreferredCurrencystringfacultatifqualificationNotesanyfacultatifqualificationStatusanyfacultatifsocialMediaUrlsanyfacultatiftaxExemptbooleanfacultatiftimezoneanyfacultatiftotalRevenuestringfacultatifwebsiteanyfacultatifcontactsany[]facultatiffinancialany[]facultatiftotalintegerfacultatifpageintegerfacultatiflimitintegerfacultatifhasMorebooleanfacultatifsummaryanyfacultatifEssayer
POST/api/trpc/tiers.linkContactLink Contact
Entrée
tiersIdstring · uuidrequiscontactIdstring · uuidrequisrolestringfacultatifisPrimarybooleanrequispar défaut
falseRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
GET/api/trpc/tiers.searchAndExportTiersSearch And Export Tiers
Entrée
searchstringfacultatiffiltersobjectfacultatiftypeenum[]facultatifstatusenum[]facultatifindustrystring[]facultatiftagsstring[]facultatifcreditScoreMinnumberfacultatifcreditScoreMaxnumberfacultatifcreatedFromanyfacultatifcreatedToanyfacultatifsortByenumrequis"name" "createdAt" "updatedAt" "creditScore" · par défaut "name"sortOrderenumrequis"asc" "desc" · par défaut "asc"pagenumberrequis≥ 1 · par défaut
1limitnumberrequis1–1000 · par défaut
50exportbooleanrequispar défaut
falseexportFormatenumrequis"CSV" "EXCEL" · par défaut "CSV"Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/tiers.toggleTiersStatusToggle Tiers Status
Entrée
idstring · uuidrequisstatusenumrequis"ACTIVE" "INACTIVE" "ARCHIVED"Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/tiers.unlinkContactUnlink Contact
Entrée
tiersIdstring · uuidrequiscontactIdstring · uuidrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/tiers.updateActivityUpdate Activity
Entrée
tiersIdstring · uuidfacultatiftypeenumfacultatif"CALL" "EMAIL" "MEETING" "TASK" "NOTE" "DOCUMENT_SHARED" "QUOTE_SENT" "PROPOSAL_SENT" "CONTRACT_SIGNED" "PAYMENT_RECEIVED" …subjectstringfacultatif≥ 1 car.
descriptionstringfacultatifscheduledAtanyfacultatifcontactIdstring · uuidfacultatifopportunityIdstring · uuidfacultatifeventIdstring · uuidfacultatifpriorityenumfacultatif"LOW" "MEDIUM" "HIGH" "URGENT" · par défaut "MEDIUM"metadataobjectfacultatifidstring · uuidfacultatifstatusenumfacultatif"PENDING" "COMPLETED" "CANCELLED"outcomestringfacultatifnotesstringfacultatifcompletedAtanyfacultatifdurationnumberfacultatif≥ > 0
Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/tiers.updateFinancialInfoUpdate Financial Info
Entrée
tiersIdstring · uuidrequisfinancialDataobjectrequistotalRevenuenumberfacultatif≥ 0
outstandingBalancenumberfacultatif≥ 0
averageOrderValuenumberfacultatif≥ 0
lifetimeValuenumberfacultatif≥ 0
creditLimitnumberfacultatif≥ 0
creditUsednumberfacultatif≥ 0
paymentTermsstringfacultatifcreditScorenumberfacultatif0–1000
riskLevelenumfacultatif"LOW" "MEDIUM" "HIGH"lastPaymentDateanyfacultatiffirstOrderDateanyfacultatiflastOrderDateanyfacultatifpaymentConditionanyfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
POST/api/trpc/tiers.updateOpportunityUpdate Opportunity
Entrée
tiersIdstring · uuidfacultatifnamestringfacultatif≥ 1 car.
descriptionstringfacultatifstatusenumfacultatif"LEAD" "QUALIFIED" "PROPOSAL" "NEGOTIATION" "CLOSED_WON" "CLOSED_LOST"sourceenumfacultatif"WEBSITE" "REFERRAL" "COLD_CALL" "EMAIL_CAMPAIGN" "SOCIAL_MEDIA" "TRADE_SHOW" "PARTNER" "OTHER"stagestringfacultatifvaluenumberfacultatif≥ > 0
probabilitynumberfacultatif0–100 · par défaut
0expectedCloseDateanyfacultatifprimaryContactIdstring · uuidfacultatifassignedToIdstring · uuidfacultatiflostReasonstringfacultatifcompetitorInfostringfacultatifnextActionstringfacultatifnextActionDateanyfacultatifmetadataobjectfacultatifidstring · uuidfacultatifactualCloseDateanyfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/tiers.updateTiersUpdate Tiers
Entrée
idstring · uuidrequisupdatesobjectrequisnamestringfacultatif≥ 1 car.
emailstring · emailfacultatifphonestringfacultatifsiretstringfacultatifsirenstringfacultatiftvastringfacultatiftypeenumfacultatif"CLIENT" "FOURNISSEUR" "PROSPECT" "PARTENAIRE"statusenumfacultatif"ACTIVE" "INACTIVE" "ARCHIVED"industrystringfacultatifcompanySizestringfacultatifannualRevenuestringfacultatifwebsitestring · urifacultatifdescriptionstringfacultatifcreditLimitnumberfacultatif≥ 0
creditUsednumberfacultatif≥ 0
paymentTermsstringfacultatifpreferredCurrencyenumfacultatif"EUR" "USD" "GBP"taxExemptbooleanfacultatifcreditScorenumberfacultatif0–1000
riskLevelenumfacultatif"LOW" "MEDIUM" "HIGH"tagsstring[]facultatifmetadataobjectfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
users 20
GET/api/trpc/users.checkUserSiteAccessCheck User Site Access
Entrée
siteIdstringrequisRéponse
200 Succès. Le résultat est dans
result.data.json : objecthasAccessbooleanfacultatifuserSiteIdstringfacultatifrequestedSiteIdstringfacultatifisSuperAdminbooleanfacultatifEssayer
POST/api/trpc/users.createUserForSiteCreate User For Site
Entrée
firstNamestringrequis≥ 1 car.
lastNamestringrequis≥ 1 car.
emailstring · emailrequisrolesstring[]requisphonestringfacultatiftitlestringfacultatiftenantIdstringfacultatifsiteIdstringrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/users.createUserCreate User
Entrée
firstNamestringrequis≥ 1 car.
lastNamestringrequis≥ 1 car.
emailstring · emailrequisrolesstring[]requisphonestringfacultatiftitlestringfacultatiftenantIdstringfacultatifsiteIdstringfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/users.deleteUserDelete User
Entrée
userIdstringrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/users.deleteUsersDelete Users
Entrée
userIdsstring[]requisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/users.forgotPasswordForgot Password
Entrée
emailstring · emailrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/users.getAnonymousMeilisearchCredentialsGet Anonymous Meilisearch Credentials
Entrée
Aucune entrée.
Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/users.getAuthoredArticlesGet Authored Articles
Entrée
userIdstring · uuidrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
Exemple avec les seuls champs requis. Remplacez les identifiants à zéro par de vraies valeurs.
GET/api/trpc/users.getServerUsersGet Server Users
Entrée
tenantIdstringfacultatifsiteIdstringfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/users.getUserDetailsGet User Details
Entrée
userIdstringrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/users.getUserGet User
Entrée
idstringrequisRéponse
200 Succès. Le résultat est dans
result.data.json : objectidstringfacultatifupdatedAtstringfacultatifcreatedAtstringfacultatifemailVerifiedstringfacultatifblockedbooleanfacultatifnamestringfacultatifemailstringfacultatiffirstNameanyfacultatiflastNameanyfacultatiftitleanyfacultatifpasswordstringfacultatifphoneanyfacultatifimageanyfacultatifdataobjectfacultatifmenuAllowliststring[]facultatifresetTokenanyfacultatifresetTokenExpiryanyfacultatifemailVerificationTokenanyfacultatifemailVerificationTokenExpiryanyfacultatifsuperiorIdanyfacultatifsiteIdstringfacultatiftenantIdstringfacultatifcanAccessReportsbooleanfacultatifcanManageCashbooleanfacultatifcanSupervisorOverridebooleanfacultatifcanVoidTransactionsbooleanfacultatifcurrentShiftStartanyfacultatifemployeeNumberanyfacultatifisClockedInbooleanfacultatifmaxDiscountPercentintegerfacultatifposPermissionsanyfacultatifposPinanyfacultatifposRolestringfacultatifEssayer
GET/api/trpc/users.getUserProfileGet User Profile
Entrée
userIdstringrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/users.getUserRolesGet User Roles
Entrée
userIdstringrequisRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
GET/api/trpc/users.getUsersGet Users
Entrée
pagenumberrequispar défaut
0per_pagenumberrequispar défaut
10searchstringfacultatifsortstringfacultatifadvancedSortsobject[]facultatiffieldstringrequisdirectionenumrequis"asc" "desc"advancedFiltersobjectfacultatiffiltersobjectfacultatifhidden_columnsstring[]facultatiftenantIdstringfacultatifsiteIdstringfacultatifRéponse
200 Succès. Le résultat est dans
result.data.json : objectdataobject[]facultatifidstringfacultatifupdatedAtstringfacultatifcreatedAtstringfacultatifemailVerifiedstringfacultatifblockedbooleanfacultatifnamestringfacultatifemailstringfacultatiffirstNamestringfacultatiflastNamestringfacultatiftitleanyfacultatifpasswordstringfacultatifphoneanyfacultatifimageanyfacultatifdataobjectfacultatifmenuAllowliststring[]facultatifresetTokenanyfacultatifresetTokenExpiryanyfacultatifemailVerificationTokenanyfacultatifemailVerificationTokenExpiryanyfacultatifsuperiorIdanyfacultatifsiteIdstringfacultatiftenantIdstringfacultatifcanAccessReportsbooleanfacultatifcanManageCashbooleanfacultatifcanSupervisorOverridebooleanfacultatifcanVoidTransactionsbooleanfacultatifcurrentShiftStartanyfacultatifemployeeNumberanyfacultatifisClockedInbooleanfacultatifmaxDiscountPercentintegerfacultatifposPermissionsanyfacultatifposPinanyfacultatifposRolestringfacultatiftenantobjectfacultatifnamestringfacultatifcodestringfacultatifstatusstringfacultatifsiteobjectfacultatifnamestringfacultatifslugstringfacultatifstatusstringfacultatifrolesobject[]facultatifnamestringfacultatiflabelstringfacultatiffullNamestringfacultatifroleNamesstringfacultatifstatusstringfacultatifisAdminbooleanfacultatifprimaryRolestringfacultatifpaginationobjectfacultatifpageintegerfacultatifper_pageintegerfacultatiftotalintegerfacultatiftotal_pagesintegerfacultatifEssayer
GET/api/trpc/users.listList
Entrée
searchstringfacultatiflimitnumberrequispar défaut
50tenantIdstringfacultatifsiteIdstringfacultatifonlyAuthorsbooleanfacultatifRéponse
200 Succès. Le résultat est dans
result.data.json : object[]idstringfacultatifnamestringfacultatifemailstringfacultatifimageanyfacultatifEssayer
GET/api/trpc/users.listMyUsersList My Users
Entrée
pagenumberrequispar défaut
0per_pagenumberrequispar défaut
10searchstringfacultatifsortstringfacultatifadvancedSortsobject[]facultatiffieldstringrequisdirectionenumrequis"asc" "desc"advancedFiltersobjectfacultatiffiltersobjectfacultatifhidden_columnsstring[]facultatifRéponse
200 Succès. Le résultat est dans
result.data.json : objectdataobject[]facultatifidstringfacultatifupdatedAtstringfacultatifcreatedAtstringfacultatifemailVerifiedstringfacultatifblockedbooleanfacultatifnamestringfacultatifemailstringfacultatiffirstNamestringfacultatiflastNamestringfacultatiftitleanyfacultatifpasswordstringfacultatifphoneanyfacultatifimageanyfacultatifdataobjectfacultatifmenuAllowliststring[]facultatifresetTokenanyfacultatifresetTokenExpiryanyfacultatifemailVerificationTokenanyfacultatifemailVerificationTokenExpiryanyfacultatifsuperiorIdanyfacultatifsiteIdstringfacultatiftenantIdstringfacultatifcanAccessReportsbooleanfacultatifcanManageCashbooleanfacultatifcanSupervisorOverridebooleanfacultatifcanVoidTransactionsbooleanfacultatifcurrentShiftStartanyfacultatifemployeeNumberanyfacultatifisClockedInbooleanfacultatifmaxDiscountPercentintegerfacultatifposPermissionsanyfacultatifposPinanyfacultatifposRolestringfacultatiftenantobjectfacultatifnamestringfacultatifcodestringfacultatifstatusstringfacultatifsiteobjectfacultatifnamestringfacultatifslugstringfacultatifstatusstringfacultatifrolesobject[]facultatifnamestringfacultatiflabelstringfacultatiffullNamestringfacultatifroleNamesstringfacultatifstatusstringfacultatifisAdminbooleanfacultatifprimaryRolestringfacultatifpaginationobjectfacultatifpageintegerfacultatifper_pageintegerfacultatiftotalintegerfacultatiftotal_pagesintegerfacultatifEssayer
POST/api/trpc/users.resetPasswordWithTokenReset Password With Token
Entrée
tokenstringrequis≥ 1 car.
passwordstringrequis≥ 8 car.
Réponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/users.sendPasswordResetEmailSend Password Reset Email
Entrée
emailstring · emailrequistenantIdstring · uuidfacultatifsiteIdstring · uuidfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/users.updateUserUpdate User
Entrée
idstringrequisnamestringfacultatiffirstNamestringfacultatiflastNamestringfacultatifemailstring · emailfacultatiftitlestringfacultatifphonestringfacultatifimagestringfacultatifblockedbooleanfacultatifemailVerifiedanyfacultatifroleIdsstring[]facultatifdataobjectfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer
POST/api/trpc/users.updateUserProfileUpdate User Profile
Entrée
firstNamestringrequislastNamestringrequisphonestringfacultatifemailstring · emailrequiscompanyNamestringfacultatifaddressstringfacultatifbiostringfacultatiftwitterUrlstringfacultatiflinkedinUrlstringfacultatifwebsitestringfacultatifuserIdstringfacultatifRéponse
200 Succès. Le résultat est dans
result.data.jsonLe format du résultat n'est pas encore documenté pour cette procédure.
Essayer