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

Antavo Transactions API

Endpoints providing customer information regarding specified transaction ids.

Antavo Transactions API is one of 29 APIs that Antavo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

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

Requests are made against 2 base URLs: https://api.staging.antavo.com, https://read-api..antavo.com.

6 operations 5 paths 21 schemas 5 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.antavo.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Antavo Transactions API declares 1 security scheme for authenticating requests. An API key is passed in the query as api_key (api_key).

  • api_key — Provides API Key access to the endpoint

Paths & Operations 6

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

Transactions 6

Endpoints providing customer information regarding specified transaction ids.

GET
/customers/{customer_id}/transactions/-/search
Search transactions for a specific customer using criteria
5 params → 200
POST
/customers/{customer_id}/transactions/-/search
Perform bulk transaction search for a specific customer
1 param body → 200
GET
/customers/{customer_id}/transactions/{transaction_id}/events
List all events associated with a specified transaction for a specific customer
6 params → 200404
GET
/customers/{customer_id}/transactions/{transaction_id}
Retrieve a specified transaction for a specific customer
3 params → 200404
GET
/customers/{customer_id}/transactions
Retrieve the transaction history for a specific customer
4 params → 200404
GET
/v1/customers/{customer_id}/transactions
Retrieve the list of a customer's transactions
listCustomerTransactions 5 params → 2004014225XX

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are TransactionEntity (15 properties), TransactionItem (12 properties), Transaction (10 properties), TransactionPerTransactionContent (10 properties). Each schema is shown below with its type and property counts.

Transaction
object
10 properties
Transaction2
object
7 properties
transrequest
object
4 properties
Status8
string
Transaction status. Can be one of:
TransactionPerTransactionContent
object
10 properties
CustomernotfoundErrorResponse
object
This describes the structure returned if an error occurred
1 property
TransactionHistoryResponse2
object
1 property
TransactionPerTransactionResponse
object
1 property
TransactionHistoryResponse
object
1 property
TransactionEventsHistoryResponse
object
1 property
ErrorResponse
object
This describes the structure returned if an error occurred
1 property
TransactionEvents
object
6 properties
PaginationLinks
object
2 properties 2 required
TransactionItem
object
An item included in the transaction.
12 properties
CollectionMetadata
object
1 property 1 required
CustomerTransactionSortEntry
object
Defines a single sorting instruction by specifying the field and direction.
2 properties 2 required
TransactionsFilter
object
Filter by allowed fields and operators.
7 properties
ErrorEnvelope
object
1 property 1 required
TransactionEventReference
object
A summary of an event associated with the transaction.
3 properties
TransactionEntity
object
A transaction registered for the customer, including its items, associated events, point values, and current processing status. The fields returned may vary de…
15 properties
SortDirection
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

antavo-transactions-api-openapi.yml Raw ↑

Other APIs Antavo publishes across the network.

Antavo Activities API
Antavo Async Events API
Antavo Authentication API
Antavo Cart API
Antavo Challenges API
Antavo Clubs API
Antavo Content consumption API
Antavo Contests API
Antavo Coupon pools API
Antavo Coupons API
Antavo Customer lists API
Antavo Customers API
Where this information came from

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