Skip to main content
PUT
/
stores
/
{storeId}
/
affiliates
/
configure
Update store affiliate options.
curl --request PUT \
  --url https://api.komerza.com/stores/{storeId}/affiliates/configure \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "isEnabled": true,
  "defaultReturnPercentage": 50,
  "canConvertAffiliateBalance": true,
  "isPublicRegistrationEnabled": true,
  "isLinkEditingEnabled": true,
  "defaultPercentageOff": 50
}
'
{
  "success": true,
  "message": "<string>",
  "code": "<string>",
  "data": "<unknown>"
}

Authorizations

​
Authorization
string
header
required

Your API key goes here

Path Parameters

​
storeId
string<uuid>
required

Body

application/json

Represents the configuration options for affiliate settings in a store.

​
isEnabled
boolean
required

Determines if the affiliate settings are active for the store.

​
defaultReturnPercentage
integer<int32>
required

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

Required range: 0 <= x <= 100
​
canConvertAffiliateBalance
boolean
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

​
isPublicRegistrationEnabled
boolean
required

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

​
isLinkEditingEnabled
boolean
required

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

​
defaultPercentageOff
integer<int32> | null

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

Required range: 0 <= x <= 100

Response

200 - application/json

The object was successfully updated.

Represents a default generic response for API endpoints.

​
success
boolean
required

Indicates whether the operation or response was successful.

​
message
string | null

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

​
code
string | null

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

​
data
any | null

Represents the data associated with a response.