Skip to main content
POST
/
bitlogin
/
api
/
open
/
v1
/
loyalty
/
reward-options
Create reward option
curl --request POST \
  --url https://api.bitbybit.studio/bitlogin/api/open/v1/loyalty/reward-options \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "rewardName": "<string>",
  "costToRedeem": 2,
  "discountValue": "<string>",
  "voucherPrefix": "<string>",
  "minimumPurchaseAmount": "<string>"
}
'
{
  "id": "<string>",
  "companyId": 123,
  "rewardName": "<string>",
  "costToRedeem": 123,
  "discountValue": 123,
  "voucherPrefix": "<string>",
  "minimumPurchaseAmount": 123,
  "priceRuleId": "<string>",
  "startsAt": "2023-11-07T05:31:56Z",
  "endsAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://knowledge.bitbybit.studio/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

API key for authentication. Create one in Settings > Developer.

Body

application/json
​
rewardName
string
required
​
costToRedeem
integer
required
Required range: x >= 1
​
discountType
enum<string>
required
Available options:
fixed_amount,
percentage,
free_shipping
​
discountValue
required

Decimal string up to 4 decimals. Percentage must be 1-100.

​
expirationPreset
enum<string>
required
Available options:
NO_EXPIRATION,
SEVEN_DAYS,
THIRTY_DAYS,
NINETY_DAYS,
ONE_YEAR
​
voucherPrefix
string | null
​
minimumPurchaseAmount

Decimal string up to 4 decimals.

Response

201 - application/json

Created

​
id
string
​
companyId
integer
​
rewardName
string
​
costToRedeem
integer
​
discountType
enum<string>
Available options:
fixed_amount,
percentage,
free_shipping
​
discountValue
number
​
voucherPrefix
string | null
​
minimumPurchaseAmount
number
​
expirationPreset
enum<string>
Available options:
NO_EXPIRATION,
SEVEN_DAYS,
THIRTY_DAYS,
NINETY_DAYS,
ONE_YEAR
​
priceRuleId
string
​
startsAt
string<date-time>
​
endsAt
string<date-time> | null
​
createdAt
string<date-time>
​
updatedAt
string<date-time>