Affiliate

Void (cancel) a previously recorded affiliate payout (by payoutId).

Marks the payout as voided, restores balances, and records the admin and reason. Requires the stores.affiliates.update permission.

patch/stores/{storeId}/affiliates/{customerId}/payouts/{payoutId}

Request

Base URL
https://api.komerza.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/komerza/apis/komerza-api/docs/stores/:storeId/affiliates/:customerId/payouts/:payoutId/patch.ts
A function with typed inputs. Its response is checked against the schema.

storeIdstring uuid required

customerIdstring uuid required

payoutIdstring uuid required

reasonstring required

A non‐empty reason describing why this payout was voided.

The object was successfully updated.

successboolean required

Indicates whether the operation or response was successful.

messagestring nullable

A descriptive message providing additional context or information about the response.

codestring nullable

The error code (if there was an error) to use when referencing the error

No recorded changes to this operation across all 1 revision of this API.