get
https://api.staging.deliverect.com/loyalty//configuration
This endpoint provides information such as settings, features and requirements based on the account's configuration.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
| Field name | Type | Description |
|---|---|---|
| enabled | bool | Indicates whether a loyalty provider is active for this channel link. |
| providerName | string | The display name of the active loyalty provider. |
| externalSignUpUrl | string | null | Some providers will only support a external sign-up process. The channel can then redirect customers to this URL. |
| features | object | Holds information on the features and requirements for the active loyalty provider. |
| features.supportsSSO | bool | Indicates whether the loyalty provider supports SSO. |
| features.supportsExternalSignUpUrl | bool | Indicates whether the loyalty provider supports external sign-up url. |
| features.supportsWalletPointsBalance | bool | Indicates whether the loyalty provider supports a point-based earning/spending system. |
| features.supportsWalletCashBalance | bool | Indicates whether the loyalty provider supports a cash-based earning/spending system. |
| features.supportsBOGOFPrograms | bool | Indicates whether the loyalty provider supports buy-one-get-one-free programs. |
| features.supportsFreeItemPrograms | bool | Indicates whether the loyalty provider supports free item programs. |
| features.supportsFlatPrograms | bool | Indicates whether the loyalty provider flat-off-order programs |
| features.requiresEmail | bool | Indicates whether the loyalty provider requires this field for creating a user. |
| features.requiresPhoneNumber | bool | Indicates whether the loyalty provider requires this field for creating a user. |
| features.supportsDynamicConfiguration | bool | Indicates whether the loyalty provider is able to retrieve configuration from the loyalty partner at runtime, such as cashback settings, wallet support for cash/points, etc. |
| cashbackConfig | CashbackConfig | Contains cashback related configuration. See CashbackConfigfor more details |
Table: CashbackConfig
| Field | Type | Default | Nullable | Description |
|---|---|---|---|---|
| title | String | None | Yes | The title of the cashback program. |
| description | String | None | Yes | A marketing description of the program. |
| earningRules | List[CashbackEarningRule] | [] | No | Rules defining how customers earn rewards. |
| burningRules | List[CashbackBurningRule] | [] | No | Rules defining how customers spend rewards. |
Table: CashbackReward
| Field | Type | Default | Nullable | Description |
|---|---|---|---|---|
| type | String | (Required) | No | Reward type: "percentage" or "fixed". |
| value | Integer | (Required) | No | The numeric value of the reward.
|
Table: CashbackEarningRule
| Field | Type | Default | Nullable | Description |
|---|---|---|---|---|
| type | String | (Required) | No | Earning type: "cash_back" or "sign_up". |
| reward | CashbackReward | (Required) | No | The specific reward associated with this rule. |
Table: CashbackBurningRule
| Field | Type | Default | Nullable | Description |
|---|---|---|---|---|
| type | CashBackBurningRuleType | (Required) | No | Always purchase. |
| cost | CashbackBurningRuleCostPercentage CashbackBurningRuleCostFixed | (Required) | No | The cost details (Percentage or Fixed). |
Table: CashbackBurningRuleCostPercentage
| Field | Type | Default | Nullable | Description |
|---|---|---|---|---|
| type | Literal ("percentage") | "percentage" | No | Identifier for percentage-based costs. |
| value | Integer | (Required) | No | The percentage value. |
| maxBurningAmount | Integer | None | Yes | Maximum amount that can be burned per transaction. |
Table: CashbackBurningRuleCostFixed
| Field | Type | Default | Nullable | Description |
|---|---|---|---|---|
| type | String | "fixed" | No | Identifier for fixed-amount costs. |
| value | Integer | (Required) | No | The fixed amount value. |