How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Otter Manager Loyalty Endpoints API

Endpoints to manage loyalty.

Otter Manager Loyalty Endpoints API is one of 27 APIs that Otter publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Manager Loyalty Endpoints. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, an API reference, authentication docs, rate-limit docs, and 2 JSON Schemas.

This API exposes 8 operations across 7 paths, and defines 33 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://{public-api-url}/.

8 operations 7 paths 33 schemas 3 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://{public-api-url}
Authentication
OAuth 2.0
Contact
License
Proprietary
Resource Areas
1

Authentication & Security 1

Otter Manager Loyalty Endpoints API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2.0) using the clientCredentials and authorizationCode flows, exposing 29 scopes.

  • OAuth2.0 — The Authorization API is based on the [OAuth2.0 protocol](https://tools.ietf.org/html/rfc6749), supporting the (Client Credentials)[https://datatracker.ietf.or…

Paths & Operations 8

Across 7 paths, the API surfaces 8 operations — 3 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Manager Loyalty Endpoints 8

Endpoints to manage loyalty.

GET
/manager/loyalty/v1/{source}/user/enrollment-config
Otter Get Enrollment Config for a Loyalty Provider
getEnrollmentConfig 2 params → 200400401403422
GET
/manager/loyalty/v1/{source}/user
Otter Get User by Id
getUser 3 params → 200401403404422
POST
/manager/loyalty/v1/{source}/user
Otter Create a Loyalty User
createUser 2 params body → 200400401403422
GET
/manager/loyalty/v1/{source}/user/search
Otter Search Loyalty Users
searchUsers 5 params → 200400401403422
POST
/manager/loyalty/v1/{source}/rewards/evaluate
Otter Compute Applicable Rewards
computeApplicableRewards 2 params body → 200400401403422
POST
/manager/loyalty/v1/{source}/rewards/simulate
Otter Simulate Rewards
simulateRewards 2 params body → 200400401403422
POST
/manager/loyalty/v1/{source}/rewards/redeem-and-accumulate
Otter Redeem and Accumulate Rewards
redeemAndAccumulateRewards 2 params body → 200400401403422
POST
/manager/loyalty/v1/{source}/rewards/refund
Otter Refund Rewards
refundRewards 2 params body → 200400401403422

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are Reward (7 properties), Item-2 (5 properties), Order-2 (4 properties), Totals (4 properties). Each schema is shown below with its type and property counts.

SelectedMenuReward
object
Indicates the item the user want to redeem, if reward type is MENUS, this should be present.
1 property
EnrollmentField
object
4 properties
User
object
2 properties
StoreId
string
The unique identifier of the store in the partner application. This ID, along with the Application ID, will be used to match the correct store when performing…
ComputeApplicableRewardsResponse
object
Response body for ComputeApplicableRewards API call.
1 property
Subtotal
object
1 property
SelectedReward
object
3 properties
CreateUserRequest
object
Request body for CreateUser API call.
1 property 1 required
ErrorDetail
object
The error detail response object.
2 properties
GetEnrollmentConfigResponse
object
Response body for GetEnrollmentConfig API call.
1 property
RefundRewardsRequest
object
Request body for RefundRewards API call.
2 properties 2 required
Totals
object
4 properties
ErrorMessage
object
The error response object.
2 properties
Item-2
object
5 properties
UserField
object
2 properties
Order-2
object
4 properties
TriggerMenu
object
3 properties
UserAccount
object
3 properties
RewardEffect
object
Shows how much is deducted from total.
1 property
Trigger
object
The preconditions to redeem this reward, for example, buy Fries to get a free Burger. Nullable, if null, this reward can be unconditionally redeemed.
1 property
RedeemAndAccumulateRewardsRequest
object
Request body for RedeemAndAccumulateRewards API call.
3 properties 3 required
ComputeApplicableRewardsRequest
object
Request body for ComputeApplicableRewards API call.
2 properties 1 required
SimulateRewardsResponse
object
Response body for SimulateRewards API call.
2 properties
SearchUsersResponse
object
Response body for SearchUsers API call.
2 properties
GetUserResponse
object
Response body for GetUser API call.
1 property
SubtotalReward
object
2 properties
RefundRewardsResponse
object
Response body for RefundRewardsResponse API call.
1 property
RedeemAndAccumulateRewardsResponse
object
Response body for RedeemAndAccumulateRewards API call.
3 properties
CreateUserResponse
object
Response body for CreateUser API call.
1 property
MenusReward
object
3 properties
UserBalance
object
2 properties
Reward
object
7 properties
SimulateRewardsRequest
object
Request body for SimulateRewards API call.
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

otter-manager-loyalty-endpoints-api-openapi.yml Raw ↑

Other APIs Otter publishes across the network.

Otter Account Pairing Endpoints API
Otter Auth Endpoints API
Otter Callback Endpoints API
Otter Delivery Endpoints API
Otter Direct Orders Endpoints API
Otter Finance Endpoints API
Otter Inventory Endpoints API
Otter Manager Menu Endpoints API
Otter Manager Order Endpoints API
Otter Manager Storefront Endpoints API
Otter Market Intel Endpoints API
Otter Menus Endpoints API
Where this information came from

This is an independent, third-party profile of Otter Manager Loyalty Endpoints API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.