v1

latestOpenAPI 3.0.02026-07-26868170.3 KB

Reward

Grant a reward

Grant a reward to a member that he can use.

post/loyalty/v1/rewards/{id}/grant

Path parameters

idstring required

Reward external identifier.

Request body

card_codestring required

quantityinteger

reason_msgstring

grant_datestring

burned_datestring

validity_startstring

validity_endstring

store_idstring

attribution_idsstring[]

idempotency_keystring

Example request

{
  "card_code": "44010000002",
  "quantity": 2,
  "reason_msg": "Catching up summer's free cake offer.",
  "grant_date": "2018-01-12 15:00:00",
  "burned_date": "2018-01-12 15:00:00",
  "validity_start": "2018-01-12 15:00:00",
  "validity_end": "2019-01-12 15:00:00",
  "store_id": "store01",
  "attribution_ids": [
    "reward_attribution_id_1",
    "reward_attribution_id_2"
  ],
  "idempotency_key": "733d3ebf-36fe-41f4-8468-c463202225c1"
}

Response

Reward grant is successful.