Yotpo Loyalty API
Loyalty and referrals customers, orders, and redemptions.
Yotpo Loyalty API is one of 4 APIs that Yotpo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Loyalty. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 4 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Yotpo Loyalty 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 4
Across 4 paths, the API surfaces 4 operations — 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.
Loyalty and referrals customers, orders, and redemptions.
Schemas 6
The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are LoyaltyCustomer (6 properties), LoyaltyOrder (4 properties), RedemptionOption (3 properties), RedemptionRequest (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Yotpo 3
Other APIs Yotpo publishes across the network.