Enter points for a loyalty program member

Request Information

Headers

NameDescriptionTypeAdditional information
Authentication

Authentication token

string

Required

URI Parameters

NameDescriptionTypeAdditional information
accountid

Your account id

globally unique identifier

Required

isPunch

If the loyalty program is punch-based, and you are recording a punch, set this value to True. Otherwise, it should be False. Default value is False.

boolean

Optional

Default value is False

Body Parameters

Transaction

ApiLPTransaction
NameDescriptionTypeAdditional information
MemberId

globally unique identifier

None.

EmployeeId

globally unique identifier

None.

Created

date

None.

Points

integer

None.

Amount

decimal number

None.

StoreNumber

string

None.

Invoice

string

None.

IgnoreWebHook

boolean

None.

Request Formats

application/json

Sample:
{
  "MemberId": "D18879DC-D9CA-490E-A3C2-C21B191186E0",
  "EmployeeId": "6109929A-C482-48AC-9FC2-B3FE73BDCAA5",
  "Amount": 10,
  "StoreNumber": "StoreNumber",
  "Invoice": "Invoice #",
  "IgnoreWebHook": true
}

Response Information

Resource Description

Transaction object

NameDescriptionTypeAdditional information
Data

ApiLPTransaction

None.

Success

boolean

None.

Messages

Collection of ErrorMessage

None.

Response Formats

application/json

Sample:
{
  "Data": {
    "MemberId": "D18879DC-D9CA-490E-A3C2-C21B191186E0",
    "EmployeeId": "6109929A-C482-48AC-9FC2-B3FE73BDCAA5",
    "Amount": 10,
    "StoreNumber": "StoreNumber",
    "Invoice": "Invoice #"
  },
  "Success": true,
  "Messages": []
}