v1

latestOpenAPI 3.0.02026-07-26868170.3 KB

Reward

Create a reward

Create a new reward that can be given to members.

post/loyalty/v1/rewards

Request body

auto_generatedboolean

descriptionstring

external_idstring required

forced_validityboolean

forced_validity_endstring

forced_validity_startstring

holding_daysinteger required

image_urlstring

limitedboolean

max_attribution_countstring

monetaryboolean

monetary_type'percentage' | 'value'

monetary_valuenumber

Value of the reward (in percentage or currency)

namestring required

nqp_valueinteger required

Non qualifying points price of the reward.

rich_descriptionstring

validity_interval_countinteger

validity_interval_type'days' | 'weeks' | 'months' | 'years'

Example request

{
  "description": "Description",
  "external_id": "ExternalID",
  "forced_validity_end": "2018-01-12 15:34:22",
  "forced_validity_start": "2018-01-12 15:34:22",
  "holding_days": 10,
  "image_url": "https://your_image.png",
  "monetary_type": "percentage",
  "monetary_value": 5.5,
  "name": "Name",
  "nqp_value": 1,
  "rich_description": "Rich description",
  "validity_interval_count": 10,
  "validity_interval_type": "days"
}

Response

Reward creation is successful.