PipedreamHQ / PipedreamHQ/pipedream
Yotpo Loyalty & Referrals — New Actions: Adjust Points, Record Action, Set Birthday, Get/Add Customer Tags, Create Refund
- Dominant language
- JavaScript
- Stars
- 11.7k
- Forks
- 5.8k
- Avg merge
- 3d 10h
- Merged PRs (30d)
- 102
Description
_For neople. We don't have any test credentials yet, we'll share those once in_
**Is there a specific app this action is for?**
**Yotpo Loyalty & Referrals**
**Please provide a link to the relevant API docs for the specific service / operation.**
https://loyaltyapi.yotpo.com/reference/welcome
---
## Requested Actions
### Fetching
**GET `/customers` — Fetch Customer Details**
Retrieve a customer's point balance, VIP tier, and referral link. This is the primary endpoint for looking up loyalty data for a given customer.
**GET `/customer_tags` — Get Customer Tags**
Retrieves the list of tags currently assigned to a customer.
API Docs: https://loyaltyapi.yotpo.com/reference/get-customer-tags
---
### Updating / Writing
**POST `/customers` — Create/Update Customer Records**
Creates or updates a customer record — useful for email changes or manually adding a customer to the loyalty program.
**POST `/points_adjustments` — Adjust a Customer's Point Balance**
Manually add or deduct points from a customer's balance. Supports adjustment reasons (reward, redeem, refund, expire, remove earned), control over whether lifetime points are affected, and optional custom history titles.
API Docs: https://loyaltyapi.yotpo.com/reference/adjust-a-customers-point-balance
**POST `/orders` — Create Order**
Records a purchase, triggers campaign matching, and automatically awards points or discounts.
**POST `/actions` — Record a Customer Action**
Records a custom action performed by a customer (e.g. social share, referral, quiz completion). Matches against active custom action campaigns and awards points/discounts accordingly.
API Docs: https://loyaltyapi.yotpo.com/reference/record-a-customer-action
**POST `/customer_birthdays` — Set Customer Birthday**
Sets or updates the birthday (day, month, optional year) for a customer — used to trigger birthday reward campaigns.
API Docs: https://loyaltyapi.yotpo.com/reference/set-customer-birthday
**PUT `/customer_tags/add` — Add Customer Tags**
Adds one or more tags to a customer (up to 20 per request). Duplicate tags are ignored (case-insensitive).
API Docs: https://loyaltyapi.yotpo.com/reference/add-customer-tags
**POST `/refunds` — Create Refund**
Sends a refund to the Yotpo API to adjust a previously processed order — reverses points or discounts awarded for that order. Processed asynchronously.
API Docs: https://loyaltyapi.yotpo.com/reference/create-refund
Contributor guide
Research direction
Start by reading the linked Yotpo Loyalty & Referrals API documentation for each requested endpoint and comparing the required request and response fields. Implement the seven new actions and verify their behavior once test credentials are provided; done means each listed operation is available and handles its documented inputs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- api
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100