Jump to Content

UGC API Loyalty API App Developer API Help Center

API Reference

UGC API Loyalty API App Developer API Help Center

All

Pages

Start typing to search…

Getting Started

Welcome
How to use the Core API
Guidelines & conventions
App key vs. Store ID
Working with entity identifiers
Working with custom properties

Common Objects

About common objects
Address
Customer checkout information
GTIN
Line item

Authentication

About authentication
Generate Access Tokenpost

Orders

About orders
Create orderpost
Update orderpatch
Retrieve ordersget
Retrieve order by IDget

Order Fulfillments

About order fulfillments
Create order fulfillmentpost
Update order fulfillmentpatch
Retrieve order fulfillmentsget
Retrieve fulfillment by IDget

Aggregated Order Info

About aggregated order info
Send aggregated order infopost

Customers

About customers
Create or update customerpatch
Retrieve customersget
Create or update custom customer eventpatch

Products

About products
Create productpost
Update productpatch
Retrieve productsget
Retrieve product by IDget

Product Variants

About product variants
Create product variantpost
Update product variantpatch
Retrieve product variantsget
Retrieve product variant by IDget

Collections

About collections
Create collectionpost
Update collectionpatch
Retrieve collectionsget
Add product to collectionpost
Retrieve products in collectionget
Remove product from collectiondel
Retrieve list of collections for productget

Webhooks

About Webhooks
Topics
Create targetpost
Retrieve targetsget
Retrieve target by IDget
Update targetpatch
Delete targetdel
Create filterpost
Retrieve filtersget
Retrieve filter by IDget
Update filterpatch
Delete filterdel
Create subscriptionpost
Retrieve subscriptionsget
Retrieve subscription by IDget
Update subscriptionpatch
Delete subscriptiondel

Checkouts (Deprecated)

About checkouts
Create or update checkoutpatch

Yotpo SMS & Email Subscribers (Deprecated)

About subscribers
Create or update subscriberpost

Yotpo SMS & Email Analytics (Deprecated)

About Analytics
Explore
- Dimensionsget
- Measuresget
Aggregationsget
Source

Explore

Includes endpoints required for aggregation