Corals Loyalty 🎁 Rewards API

API Endpoints

Members

Endpoints for managing loyalty program members.

Get a List of Members

• Endpoint: GET /members
• Description: Retrieves a list of all members in the loyalty program.
• Optional query parameter to restrict list by Membership Level
• Response:200 OK: Returns an array of Member objects.

Create a New Member

• Endpoint: POST /members
• Description: Adds a new member to the loyalty program.
• Request Body:Required: YesContent Type: application/json
• Schema: Member
• Response:201 Created: Returns the newly created Member object.

Get Member by ID

• Endpoint: GET /members/{memberId}
• Description: Retrieves details of a specific member by ID.
• Path Parameter: memberId (string) - Required.
• Response:200 OK: Returns the Member object.404 Not Found: Member with specified ID was not found.

Update Member Information

• Endpoint: PUT /members/{memberId}
• Description: Updates information for a specific member.
• Path Parameter: memberId (string) - Required.
• Request Body:Required: YesContent Type: application/json
• Schema: Member
• Response:200 OK: Returns the updated Member object.404 Not Found: Member with specified ID was not found.

Rewards

• Endpoints for managing rewards available in the loyalty program.
• Get a List of Rewards
• Endpoint: GET /rewards
• Description: Retrieves a list of all available rewards.
• Response:200 OK: Returns an array of Reward objects.

Create a New Reward

• Endpoint: POST /rewards
• Description: Adds a new reward to the loyalty program.
• Request Body:Required: YesContent Type: application/json
• Schema: Reward
• Response:201 Created: Returns the newly created Reward object.

Get Reward by ID

• Endpoint: GET /rewards/{rewardId}
• Description: Retrieves details of a specific reward by ID.
• Path Parameter: rewardId (integer) - Required.
• Response:200 OK: Returns the Reward object.404 Not Found: Reward with specified ID was not found.

Update Reward Information

• Endpoint: PUT /rewards/{rewardId}
• Description: Updates information for a specific reward.
• Path Parameter: rewardId (string) - Required.
• Request Body:Required: YesContent Type: application/json
• Schema: Reward
• Response:200 OK: Returns the updated Reward object.404 Not Found: Reward with specified ID was not found.

Transactions

Endpoints for managing member transactions in the loyalty program.

Get a List of Transactions

• Endpoint: GET /transactions
• Description: Retrieves a list of all transactions.
• Response:200 OK: Returns an array of Transaction objects.

Create a New Transaction

• Endpoint: POST /transactions
• Description: Adds a new transaction for a member, such as earning or redeeming points.
• Request Body:Required: YesContent Type: application/json
• Schema: Transaction
• Response:201 Created: Returns the newly created Transaction object.

Get Transaction by ID

• Endpoint: GET /transactions/{transactionId}
• Description: Retrieves details of a specific transaction by ID.
• Path Parameter: transactionId (string) - Required.
• Response:200 OK: Returns the Transaction object.404 Not Found: Transaction with specified ID was not found.