Affiliate

Record a new payout (external or store-credit) for an affiliate (by customerId).

Requires the stores.affiliates.update permission.

post/stores/{storeId}/affiliates/{customerId}/payouts

Request

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

storeIdstring uuid required

customerIdstring uuid required

amountnumber double required

The amount to pay out or convert.

convertedToStoreCreditboolean required

True = convert into store credit; false = external payout.

commentstring nullable

Optional note for auditing.

The object was successfully created.

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.