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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Olo

Olo Accruals API

Loyalty point accrual and void

Documentation Provider Profile APIs.io OpenAPI GitHub

Olo Accruals API is one of 15 APIs that Olo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include Accruals. The published artifact set on APIs.io includes an OpenAPI specification, authentication docs, code examples, API documentation, and 3 JSON Schemas.

This API exposes 2 operations across 2 paths, and defines 22 schemas. It is described by OpenAPI 3.1.0, at version 1.1.

Requests are made against 2 base URLs: https://ordering.api.olosandbox.com, https://ordering.api.olo.com.

2 operations 2 paths 22 schemas 1 DELETE1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.1
Servers
https://ordering.api.olosandbox.com
https://ordering.api.olo.com
Authentication
API Key
Contact
Olo Developer Support
Resource Areas
1

Authentication & Security 1

Olo Accruals API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (OloSignature). By default, every request must be authenticated.

  • OloSignature — HMAC-SHA256 signature authorization. The signed message is the newline-joined concatenation of clientId, HTTP verb, content type, base64-encoded SHA-256 hash o…

Paths & Operations 2

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

Accruals 2

Loyalty point accrual and void

POST
/promotions/accruals
Accrue Points
accruePoints body → 200400401
DELETE
/promotions/accruals/{accrualId}
Void Accrual
voidAccrual 1 param body → 200400401

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are AccruePointsRequest (20 properties), BasketReward (8 properties), Modifier (7 properties), VoidAccrualRequest (5 properties). Each schema is shown below with its type and property counts.

Modifier
object
A POS modifier applied to a product, supporting nested modifiers.
7 properties
Source
string
The source of the order.
Basket
object
The basket contents for an order.
5 properties
ErrorCodeResponse
PosItem
object
A POS-represented basket item.
5 properties
VoidAccrualRequest
object
Request payload to void a previously recorded loyalty point accrual.
5 properties
Coupon
object
A coupon applied to a basket.
5 properties
ErrorResponse
object
Returned for error responses.
3 properties
Payment
object
A payment applied to the order.
4 properties
AccruePointsRequest
object
Request payload to accrue loyalty points for an order.
20 properties 3 required
Address
object
The destination address of the order.
4 properties
OloEntry
object
An Olo-represented basket item entry.
2 properties
BasketReward
object
A loyalty reward applied to a basket.
8 properties
TransactionEnvelope
object
An envelope wrapping a transaction result.
1 property
PosEntry
object
A POS-represented basket item entry.
2 properties
Handoff
string
The handoff method for the order.
Issuer
string
The credit card issuer. Only populated when tender is Credit.
ErrorCode
string
A machine-readable code identifying the issue with the request.
Transaction
object
The result of a Promotions operation.
1 property
Tender
string
A payment tender type.
DiscountLevel
string
The level at which a discount is applied.
OloItem
object
An Olo-represented basket item.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

olo-accruals-api-openapi.yml Raw ↑

Other APIs Olo publishes across the network.

Olo Dispatch API
AE Profile APIs.io
Olo POS Interface (OloCloud)
AE Profile APIs.io
Omnivore POS API
AE Profile APIs.io
Olo Pay API
AE Profile APIs.io
Olo Network API
AE Profile APIs.io
Olo Marketing & Guest Data Platform API
AE Profile APIs.io
Olo Host API
AE Profile APIs.io
Olo Sentiment API
AE Profile APIs.io
Olo Webhooks
AE Profile APIs.io
Olo Accounts API
AE Profile APIs.io
Olo Brand API
AE Profile APIs.io
Olo Promotions API
AE Profile APIs.io
#Accruals
← Back to O APIs
API Details
ID
olo:olo-accruals-api
Server
https://ordering.api.olosandbox.com
Docs
https://developer.olo.com/
Provider
Olo
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=olo-accruals-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/olo-accruals-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Olo Accruals 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.