Skip to content
OpenShop Logo OpenShop

Upsert Commission Provider

PATCH
/admin/store/commission-provider

Creates or updates the store’s commission provider configuration

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Creates or updates the store’s commission provider configuration

object
provider
required
string
isActive
required
boolean
isDefault
required
boolean
apiKey
required
string | null
configuration
required
Any of:
object
defaultEnrollerId
string
volumeRules
object
ruleSets
required
object
STANDARD
Array<object>
object
volumeKey
required
string
ruleType
required
string
Allowed values: STATIC CONSTANT EQUALS_SALE_PRICE EQUALS_UNIT_PRICE PERCENTAGE_OF_SALE_PRICE PERCENTAGE_OF_VOLUME PERCENTAGE_OF_VOLUME_BY_PROPERTY
position
required
number
perUnit
required
boolean
roundingMode
required
string
Allowed values: FLOOR CEIL ROUND
decimalPlaces
required
number
condition
object
productType
string
Allowed values: STANDARD ENROLLMENT
excludeVirtualProducts
boolean
minLineTotal
string
maxLineTotal
string | null
value
string
factor
string
sourceVolumeKey
string
factorPropertyKey
string
ENROLLMENT
Array<object>
object
volumeKey
required
string
ruleType
required
string
Allowed values: STATIC CONSTANT EQUALS_SALE_PRICE EQUALS_UNIT_PRICE PERCENTAGE_OF_SALE_PRICE PERCENTAGE_OF_VOLUME PERCENTAGE_OF_VOLUME_BY_PROPERTY
position
required
number
perUnit
required
boolean
roundingMode
required
string
Allowed values: FLOOR CEIL ROUND
decimalPlaces
required
number
condition
object
productType
string
Allowed values: STANDARD ENROLLMENT
excludeVirtualProducts
boolean
minLineTotal
string
maxLineTotal
string | null
value
string
factor
string
sourceVolumeKey
string
factorPropertyKey
string
FALLBACK
Array<object>
object
volumeKey
required
string
ruleType
required
string
Allowed values: STATIC CONSTANT EQUALS_SALE_PRICE EQUALS_UNIT_PRICE PERCENTAGE_OF_SALE_PRICE PERCENTAGE_OF_VOLUME PERCENTAGE_OF_VOLUME_BY_PROPERTY
position
required
number
perUnit
required
boolean
roundingMode
required
string
Allowed values: FLOOR CEIL ROUND
decimalPlaces
required
number
condition
object
productType
string
Allowed values: STANDARD ENROLLMENT
excludeVirtualProducts
boolean
minLineTotal
string
maxLineTotal
string | null
value
string
factor
string
sourceVolumeKey
string
factorPropertyKey
string
discountAllocation
object
excludeProductTypes
Array<string>
Allowed values: STANDARD ENROLLMENT
excludeVirtualProducts
boolean
decimalPlaces
required
number