latestOpenAPI 3.0.42026-07-2685196386.6 KB

060e78bc7f80

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

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