/
YO
yotpo
Search skmtc…
⌘K
Docs
Sign in
Docs
History
Schema
Generate
Filter operations
post
/v2/oauth2/token
Generate Access Token
delete
/v2/{account_id}/access_tokens/{access_token}
Remove Application
get
/core/v3/stores/{store_id}/orders
Retrieve Orders
get
/core/v3/stores/{store_id}/orders/{yotpo_order_id}/fulfillments
Retrieve Order Fulfillments
get
/core/v3/stores/{store_id}/orders/{yotpo_order_id}/fulfillments/{yotpo_fulfillment_id}
Retrieve fulfillment by ID
patch
/core/v3/stores/{store_id}/orders/{yotpo_order_id}/fulfillments/{yotpo_fulfillment_id}
Update Order Fulfillment
get
/v2/{account_id}/orders
Retrieve Orders per Account
get
/v2/{account_id}/reviews_bottomlines
Reviews Bottomlines
get
/v2/{account_id}/products
All Products
get
/v2/{account_id}/products/{external_product_id}
Product Data
get
/v2/{account_id}/promoted_products
Promoted Products
get
/core/v3/stores/{store_id}/products
Retrieve Products
get
/core/v3/stores/{store_id}/products/{yotpo_product_id}/variants
Retrieve product variants
get
/v2/{account_id}/reviews
All Reviews
get
/v2/{account_id}/products/{external_product_id}/reviews
Product Reviews
get
/v2/{account_id}/star_rating/products/{external_product_id}
Product Star Rating
get
/v2/{account_id}/reviews/{review_id}
Review by Review ID
get
/v2/{account_id}/top_reviews
Top Reviews
post
/v2/{account_id}/best_reviews
Best Reviews
post
/v2/{account_id}/best_sentences
Best Sentences
post
/v2/{store_id}/moderation/reviews
Publish/Unpublish Reviews
get
/core/v3/stores/{store_id}/customers
Retrieve Customers
patch
/core/v3/stores/{store_id}/customers
Create or Update Customer
post
/loyalty/v3/stores/{store_id}/customers
Retrieve Loyalty Customer Details by Email
post
/loyalty/v3/stores/{store_id}/points/adjust
Adjust Loyalty Customer Points
post
/loyalty/v3/stores/{store_id}/custom_actions
Record Loyalty Customer Action
get
/v2/{account_id}/reviews/{review_id}/comment
Retrieve Existing Comment
put
/v2/{account_id}/reviews/{review_id}/comment
Update Existing Comment
post
/v2/{account_id}/reviews/{review_id}/comment
Create New Comment
delete
/v2/{account_id}/reviews/{review_id}/comment
Delete Comment
get
/v2/{account_id}/questions
Retrieve All Questions
put
/v2/{account_id}/questions/{question_id}/answers
Update an Answer
post
/v2/{account_id}/questions/{question_id}/answers
Create an Answer
get
/v2/{account_id}/questions/{question_id}
Retrieve Q&A by Question ID
delete
/v2/{account_id}/questions/{question_id}/answers/{answer_id}
Delete an Answer
get
/v2/{account_id}/webhooks
All Webhooks
post
/v2/{account_id}/webhooks
Create Webhook
get
/v2/{account_id}/webhook_events
All Webhook Events
get
/v2/{account_id}/webhooks/{id}
Webhook By ID
put
/v2/{account_id}/webhooks/{id}
Update Webhook By ID
delete
/v2/{account_id}/webhooks/{id}
Delete Webhook
get
/core/v3/applications/{application_id}/webhooks/targets
Retrieve targets
post
/core/v3/applications/{application_id}/webhooks/targets
Create target
get
/core/v3/applications/{application_id}/webhooks/targets/{yotpo_target_id}
Retrieve target by ID
delete
/core/v3/applications/{application_id}/webhooks/targets/{yotpo_target_id}
Delete target
patch
/core/v3/applications/{application_id}/webhooks/targets/{yotpo_target_id}
Update target
get
/core/v3/applications/{application_id}/webhooks/filters
Retrieve filters
post
/core/v3/applications/{application_id}/webhooks/filters
Create filter
get
/core/v3/applications/{application_id}/webhooks/filters/{yotpo_filter_id}
Retrieve filter by ID
delete
/core/v3/applications/{application_id}/webhooks/filters/{yotpo_filter_id}
Delete filter
patch
/core/v3/applications/{application_id}/webhooks/filters/{yotpo_filter_id}
Update filter
get
/core/v3/applications/{application_id}/stores/{store_id}/webhooks/subscriptions
Retrieve store subscriptions
post
/core/v3/applications/{application_id}/stores/{store_id}/webhooks/subscriptions
Create store subscription
get
/core/v3/applications/{application_id}/stores/{store_id}/webhooks/subscriptions/{yotpo_subscription_id}
Retrieve store subscription by ID
delete
/core/v3/applications/{application_id}/stores/{store_id}/webhooks/subscriptions/{yotpo_subscription_id}
Delete store subscription
patch
/core/v3/applications/{application_id}/stores/{store_id}/webhooks/subscriptions/{yotpo_subscription_id}
Update store subscription
get
/core/v3/applications/{application_id}/webhooks/subscriptions
Retrieve app subscriptions
post
/core/v3/applications/{application_id}/webhooks/subscriptions
Create app subscription
get
/core/v3/applications/{application_id}/webhooks/subscriptions/{yotpo_subscription_id}
Retrieve app subscription by ID
delete
/core/v3/applications/{application_id}/webhooks/subscriptions/{yotpo_subscription_id}
Delete app subscription
patch
/core/v3/applications/{application_id}/webhooks/subscriptions/{yotpo_subscription_id}
Update app subscription
get
/core/v3/stores/{store_id}/segments
Get Segments
get
/products/{store_id}/{sku}/questions
Retrieve Q&A for a product
get
/products/{store_id}/{sku}/qna_bottomline
Retrieve the bottom line for Q&A
post
/answers/{answer_id}/vote/{vote_type}
Vote on answers
get
/v1/widget/{store_id}/albums/by_name
Photos by album
get
/v1/widget/{store_id}/albums/product/{product_id}
Product images
get
/core/v3/stores/{store_id}/orders/{yotpo_order_id}
Retrieve order by ID
get
/core/v3/stores/{store_id}/products/{yotpo_product_id}
Retrieve product by ID
get
/core/v3/stores/{store_id}/products/{yotpo_product_id}/variants/{yotpo_variant_id}
Retrieve product variant by ID
get
/loyalty/v3/stores/{store_id}/earning_rules
Retrieve Earning Rules
get
/v2/{account_id}/info
Retrieve Token Info
Webhooks
post
review_request.eligible.on_fulfillment
Review Request Eligible on Fulfillment
post
review_request.eligible.on_delivery
Review Request Eligible on Delivery
post
review_create
Review Created
post
review_updated
Review Updated
post
swell/redemption/created
Coupon Earned
post
loyalty/custom/reward/created
Custom Reward Redeemed
post
swell/customer/birthday
Customer Birthday
post
swell/birthday/captured
Customer Birthday Captured
post
swell/customer/anniversary
Customer Anniversary
post
swell/anniversary/captured
Customer Anniversary Captured
post
loyalty/donation/created
Donation Created
post
swell/account/created
Account Created
post
loyalty/opt_in
Loyalty Opt In
post
loyalty/opt_out
Loyalty Opt Out
post
swell/points/changed
Points Changed
post
swell/points/earned
Points Earned
post
swell/points/reminder
Points Reminder
post
loyalty/expiration/reminder
Points Expiration Reminder
post
swell/redemption_code/below_threshold
Redemption Below Threshold
post
swell/point_redemption/cancellation_request
Redemption Cancellation Request
post
swell/redemption/reminder
Redemption Reminder
post
swell/referral/share
Referral Link Share
post
yotpo/referral/shared
Referral Link Share (2.0)
post
swell/referral/share/reminder
Referral Share Reminder
post
loyalty/referral/product_share
Referral Product Share Link
post
loyalty/referral/product_share/reminder
Referral Product Share Reminder
post
swell/referral/completed
Referral Completed
post
yotpo/referral/completed
Referral Completed (2.0)
post
swell/tier/earned
Tier Earned
post
swell/tier/lost
Tier Lost
post
swell/tier/status/changed
Tier Status Changed
post
yotpo/tier/expiration/reminder
Tier Expiration Reminder
post
loyalty/integrations/integration_disabled
CommerceCloud Integration Disabled
post
integrations.applications.disconnected.v3
App Disconnected
Copy
Copy Markdown
Copy Markdown
Copying…
Copied
Copy failed
Changes to Retrieve Earning Rules
get
/loyalty/v3/stores/{store_id}/earning_rules
Nov 3, 2026
5bcae8239b6e
Revision changes
info
endpoint added