Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Yotpo Subscriptions API

Core API store sync and webhook subscriptions.

Yotpo Subscriptions API is one of 4 APIs that Yotpo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Subscriptions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 4 paths, and defines 6 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against 2 base URLs: https://api.yotpo.com, https://loyalty.yotpo.com/api/v2.

6 operations 4 paths 6 schemas 2 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api.yotpo.com
Authentication
API Key, API Key, API Key
Terms of Service
Resource Areas
1

Authentication & Security 3

Yotpo Subscriptions API declares 3 security schemes for authenticating requests. An API key is passed in the query as utoken (UToken). An API key is passed in the header as x-guid (LoyaltyGuid). An API key is passed in the header as x-api-key (LoyaltyApiKey).

  • UToken — OAuth access token obtained from POST /oauth/token.
  • LoyaltyGuid — Loyalty & Referrals account GUID.
  • LoyaltyApiKey — Loyalty & Referrals API key.

Paths & Operations 6

Across 4 paths, the API surfaces 6 operations — 2 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Subscriptions 6

Core API store sync and webhook subscriptions.

GET
/core/v3/stores/{store_id}/products
Retrieve products.
retrieveProducts 1 param → 200
POST
/core/v3/stores/{store_id}/products
Create a product.
createProduct 1 param body → 201
POST
/core/v3/stores/{store_id}/orders
Create an order.
createOrder 1 param body → 201
POST
/core/v3/stores/{store_id}/customers
Create or update a customer.
createOrUpdateCustomer 1 param body → 200
GET
/core/v3/stores/{store_id}/webhook_subscriptions
Retrieve webhook subscriptions.
retrieveWebhookSubscriptions 1 param → 200
POST
/core/v3/stores/{store_id}/webhook_subscriptions
Create a webhook subscription.
createWebhookSubscription 1 param body → 201

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Product (5 properties), Customer (4 properties), Order (4 properties), WebhookSubscription (3 properties). Each schema is shown below with its type and property counts.

Order
object
4 properties
Product
object
5 properties
WebhookSubscriptionList
object
1 property
WebhookSubscription
object
3 properties
ProductList
object
1 property
Customer
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yotpo-subscriptions-api-openapi.yml Raw ↑

Other APIs Yotpo publishes across the network.

Yotpo Authentication API
Yotpo Loyalty API
Yotpo Reviews API