Configure Programme
Sets whether the store supplies resellers, how they enrol, the discount they pay, and the
optional exposure and top-up limits.
Requires the stores.resellers.update permission.
Authorizations
Your API key goes here
Path Parameters
Body
Settings for a store's reseller programme.
Whether the store supplies resellers at all. Turning this off stops new draws immediately; it does not revoke anyone or touch their balance.
How new resellers get approved: Open, Application or InviteOnly.
1^(?:Open|Application|InviteOnly)$The discount off list price that resellers pay, as a percentage.
0 <= x <= 100Whether the application form invites a deposit at all. Only meaningful in
Application mode.
Whether MinimumApplicationDeposit is enforced — an application under it cannot be approved — or merely shown to the merchant when they decide.
The most unspent reseller balance the store is willing to be holding at once. Null means no cap.
0 <= x <= 1000000The smallest top-up the store will accept from a reseller. Null means no minimum.
0 <= x <= 100000The deposit the store asks an applicant for. Separate from MinimumTopUp, which governs every top-up for the rest of a reseller's life — this one only concerns getting in.
0 <= x <= 1000000Deposit at or above which an application is approved with no merchant action. Null disables automatic approval however much is deposited.
0 <= x <= 1000000Whether resellers who sell outside Komerza may buy stock in bulk up front. Null leaves the setting as it is.
Response
The object was successfully updated.
Represents a default generic response for API endpoints.
Indicates whether the operation or response was successful.
A descriptive message providing additional context or information about the response.
The error code (if there was an error) to use when referencing the error
Represents the data associated with a response.