Affiliate & Provision — API und MCP
Überblick
Dieser Bereich stellt 24 Operationen bereit. Jede davon ist zugleich ein MCP-Werkzeug.
Der Bereich hängt am Modul-Schalter module.affiliate. Ist das Modul aus, antworten diese Operationen mit 404.
Operationen
| Methode | Pfad | Zweck | Recht | Parameter |
|---|---|---|---|---|
GET | /api/v1/affiliate-settlements | Liste der AffiliateSettlementRun | affiliate.settlement.run | page, status, q |
POST | /api/v1/affiliate-settlements | Eine AffiliateSettlementRun anlegen | affiliate.settlement.run | + Rumpf |
GET | /api/v1/affiliate-settlements/{ulid} | Eine AffiliateSettlementRun lesen | affiliate.settlement.run | ulid |
POST | /api/v1/affiliate-settlements/{ulid}/approve | Approve affiliate settlement — Approve affiliate settlement. Dedicated action endpoint — not a standard CRUD create. | affiliate.settlement.run | ulid, + Rumpf |
POST | /api/v1/affiliate-settlements/{ulid}/mark-paid | Mark affiliate settlement as paid — Mark affiliate settlement as paid. Dedicated action endpoint — not a standard CRUD create. | affiliate.settlement.run | ulid, + Rumpf |
GET | /api/v1/affiliate-settlements/{ulid}/payout-csv | Auszahlungs-CSV des Abrechnungslaufs (eine Zeile je Partner; nur approved/paid). | affiliate.settlement.run | ulid |
GET | /api/v1/affiliates | Liste der Affiliate | affiliate.partner.view · affiliate.partner.manage | page, status, partnerType |
POST | /api/v1/affiliates | Eine Affiliate anlegen | affiliate.partner.manage | + Rumpf |
GET | /api/v1/affiliates/assignments | Liste der AffiliatePartnerAssignment | affiliate.partner.view · affiliate.partner.manage | page, partnerId, customerId, active |
POST | /api/v1/affiliates/assignments | Eine AffiliatePartnerAssignment anlegen | affiliate.partner.manage | + Rumpf |
DELETE | /api/v1/affiliates/assignments/{ulid} | Eine AffiliatePartnerAssignment löschen | affiliate.partner.manage | ulid |
PATCH | /api/v1/affiliates/assignments/{ulid} | Eine AffiliatePartnerAssignment ändern | affiliate.partner.manage | ulid, + Rumpf |
POST | /api/v1/affiliates/attributions | Eine AffiliateAttribution anlegen | affiliate.commission.manage | + Rumpf |
DELETE | /api/v1/affiliates/{ulid} | Eine Affiliate löschen | affiliate.partner.manage | ulid |
GET | /api/v1/affiliates/{ulid} | Eine Affiliate lesen | affiliate.partner.view · affiliate.partner.manage | ulid |
PATCH | /api/v1/affiliates/{ulid} | Eine Affiliate ändern | affiliate.partner.manage | ulid, + Rumpf |
GET | /api/v1/affiliates/{ulid}/accruals | Liste der AffiliateAccrual | affiliate.partner.view · affiliate.settlement.run | ulid, page, status |
GET | /api/v1/affiliates/{ulid}/commission-summary | Eine AffiliateCommissionSummary lesen | affiliate.partner.view · affiliate.partner.manage | ulid |
GET | /api/v1/affiliates/{ulid}/referrals | Liste der AffiliateReferral | affiliate.partner.view · affiliate.partner.manage | ulid, page |
POST | /api/v1/affiliates/{ulid}/referrals | Referral-Code des Partners anlegen — Legt einen Referral-Code bzw. -Link des Partners an. Der Code ist systemweit eindeutig (Doppelvergabe: 409); expiresAt begrenzt das Attributionsfenster. | affiliate.partner.manage | ulid, + Rumpf |
GET | /api/v1/affiliates/{ulid}/rules | Liste der AffiliateCommissionRule | affiliate.partner.view · affiliate.commission.manage | ulid |
POST | /api/v1/affiliates/{ulid}/rules | Provisionsregel des Partners anlegen — Legt eine Provisionsregel für diesen Partner an (Geltungsbereich partner). percent ist Prozent mal 100, fixed ein Betrag in Cent. | affiliate.commission.manage | ulid, + Rumpf |
DELETE | /api/v1/affiliates/{ulid}/rules/{ruleUlid} | Eine AffiliateCommissionRule löschen | affiliate.commission.manage | ulid, ruleUlid |
PATCH | /api/v1/affiliates/{ulid}/rules/{ruleUlid} | Eine AffiliateCommissionRule ändern | affiliate.commission.manage | ulid, ruleUlid, + Rumpf |
Zweckangaben, die nicht dem Standardmuster folgen, stammen unverändert aus der Schnittstellen-Beschreibung im Code.