Jump to Content
API Reference
v1.0
v3.0
UGC API
Loyalty API
App Developer API
Help Center
API Reference
Search
UGC API
Loyalty API
App Developer API
Help Center
v3.0
API Reference
Working with custom properties
All
Pages
Start typing to search…
JUMP TO
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 Token
post
Orders
About orders
Create order
post
Update order
patch
Retrieve orders
get
Retrieve order by ID
get
Order Fulfillments
About order fulfillments
Create order fulfillment
post
Update order fulfillment
patch
Retrieve order fulfillments
get
Retrieve fulfillment by ID
get
Aggregated Order Info
About aggregated order info
Send aggregated order info
post
Customers
About customers
Create or update customer
patch
Retrieve customers
get
Create or update custom customer event
patch
Products
About products
Create product
post
Update product
patch
Retrieve products
get
Retrieve product by ID
get
Product Variants
About product variants
Create product variant
post
Update product variant
patch
Retrieve product variants
get
Retrieve product variant by ID
get
Collections
About collections
Create collection
post
Update collection
patch
Retrieve collections
get
Add product to collection
post
Retrieve products in collection
get
Remove product from collection
del
Retrieve list of collections for product
get
Webhooks
About Webhooks
Topics
Create target
post
Retrieve targets
get
Retrieve target by ID
get
Update target
patch
Delete target
del
Create filter
post
Retrieve filters
get
Retrieve filter by ID
get
Update filter
patch
Delete filter
del
Create subscription
post
Retrieve subscriptions
get
Retrieve subscription by ID
get
Update subscription
patch
Delete subscription
del
Checkouts (Deprecated)
About checkouts
Create or update checkout
patch
Yotpo SMS & Email Subscribers (Deprecated)
About subscribers
Create or update subscriber
post
Yotpo SMS & Email Analytics (Deprecated)
About Analytics
Explore
Dimensions
get
Measures
get
Aggregations
get
Source
Campaigns
get
Automations
get
Flows
get
Working with custom properties
Ask AI
