Commissions

Commission resource client for commission management

Access through sdk.commissions on a Lomadee instance. Import types from @thelomadee/sdk/domains.

import type {
  ListCommissionQuery,
  CreateCommissionBody,
  UpdateCommissionBody,
  CommissionData,
  CommissionListResponse,
  CommissionRecurringOptions,
} from '@thelomadee/sdk/domains';
import type { SdkResponse } from '@thelomadee/sdk';

Access to the commissions client depends on what your integration is provisioned for during onboarding. Confirm commission API availability with your Lomadee contact before building against these methods.

list returns CommissionListResponse. get, create, and update return SdkResponse<CommissionData>.

list

list(query: ListCommissionQuery): Promise<CommissionListResponse>

Parameters — ListCommissionQuery

page · number

Optional page index.

limit · number

Optional page size.

Returns

Promise<CommissionListResponse> — { data: CommissionData[]; count: number }.

Example

const { data, count } = await sdk.commissions.list({ page: 1, limit: 20 });

---

get

get(id: string): Promise<SdkResponse<CommissionData>>

id · string · required

Commission identifier.

Returns

Promise<SdkResponse<CommissionData>> — { data: CommissionData }.

---

create

create(body: CreateCommissionBody): Promise<SdkResponse<CommissionData>>

Parameters — CreateCommissionBody

name · string · required

Commission name.

type · 'fixed' | 'percentage' · required

Commission calculation type.

active · boolean

Optional active flag.

value · number · required

Commission value (number in SDK types; interpretation depends on type).

isDefault · boolean

Optional default flag.

startAt · string

Optional start timestamp (string format not specified in SDK types).

endAt · string

Optional end timestamp (string format not specified in SDK types).

transfer · string

Optional transfer field.

recurringOptions · CommissionRecurringOptions

Optional recurring configuration. See CommissionRecurringOptions.

Returns

Promise<SdkResponse<CommissionData>>.

Example

const { data } = await sdk.commissions.create({
  name: 'Default commission',
  type: 'percentage',
  value: 10,
  recurringOptions: { months: 12, limitless: false },
});

---

update

update(id: string, body: UpdateCommissionBody): Promise<SdkResponse<CommissionData>>

id · string · required

Commission identifier.

UpdateCommissionBody has the same fields as CreateCommissionBody, including optional recurringOptions.

Returns

Promise<SdkResponse<CommissionData>>.

---

delete

delete(id: string): Promise<void>

id · string · required

Commission identifier.

Returns

Promise<void>.

---

CommissionRecurringOptions

months · number

Optional number of months.

firstPaymentEnabled · boolean

Optional first-payment flag.

firstPaymentCommissionType · 'fixed' | 'percentage'

Optional first-payment commission type.

firstPaymentCommissionValue · number

Optional first-payment commission value.

limitless · boolean

Optional limitless flag.

CommissionListResponse

data · CommissionData[] · required

Page of commission records.

count · number · required

Total count for the query.

CommissionData

Fields on list items and inside SdkResponse.data for get/create/update:

id · string · required

Commission identifier.

name · string · required

Commission name.

type · string · required

Commission type (response uses string; request accepts 'fixed' | 'percentage').

active · boolean · required

Active flag.

isDefault · boolean · required

Default flag.

value · number · required

Commission value.

startAt · string | null

Optional start timestamp; may be null.

endAt · string | null

Optional end timestamp; may be null.

transfer · string · required

Transfer field.

categoryIds · string[] · required

Category identifiers.

channelIds · string[] · required

Channel identifiers.

productIds · string[] · required

Product identifiers.

recurringOptions · CommissionRecurringOptions

Optional recurring configuration.

createdAt · string · required

Creation timestamp.

updatedAt · string

Optional update timestamp.

Related

• Client
• Error handling