Sign in

v1

latestOpenAPI 3.0.42026-07-2685196386.6 KB
Affiliate

Update store affiliate options.

Updates the configuration options for the affiliate program of the specified store. Requires the stores.affiliates.update permission.

put/stores/{storeId}/affiliates/configure

Path parameters

storeIdstring uuid required

Request body

isEnabledboolean required

Determines if the affiliate settings are active for the store.

defaultReturnPercentageinteger required

Specifies the default return percentage for affiliates within a store, ranging from 0 to 100.

defaultPercentageOffinteger nullable

Represents the default percentage off value used in affiliate settings, where the value must be between 0 and 100.

canConvertAffiliateBalanceboolean required

Whether the store allows affiliate balance to be converted into customer balance to be used on the store, when enabled any affiliate can convert their affiliate balance into customer balance automatically

isPublicRegistrationEnabledboolean required

Determines whether public registration is enabled for affiliates within the store.

isLinkEditingEnabledboolean required

Indicates whether link editing capabilities are enabled within the affiliate options for a store.

Response

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

{"stackTrail":"components:schemas:ObjectResponse:properties:data","oasType":"schema","type":"unknown","description":"Represents the data associated with a response.","nullable":true}