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

Neon Commerce Reports API

The Reports API from Neon Commerce — 1 operation(s) for reports.

Neon Commerce Reports API is one of 13 APIs that Neon Commerce publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 1 operation across 1 path, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 1.

Requests are made against a single base URL, https://api.neonpay.com.

1 operations 1 paths 3 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1
Base URL
https://api.neonpay.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Neon Commerce Reports API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Api-Key (GlobalApiKey). By default, every request must be authenticated.

  • GlobalApiKey — Your Global API key, which spans across environments. Sandbox keys are prefixed with gksandbox; production keys are prefixed with gk. Find your keys in the Neo…

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Reports 1
GET
/reports/{reportId}
Retrieve Report details
getReport 1 param → 200400404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are APIError (4 properties), ErrorDetail (2 properties), ReportNotFoundError (1 property). Each schema is shown below with its type and property counts.

ErrorDetail
object
2 properties 2 required
APIError
object
4 properties 2 required
ReportNotFoundError
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

neon-commerce-reports-api-openapi.yml Raw ↑

Other APIs Neon Commerce publishes across the network.

Neon Commerce Account API
Neon Commerce Assets API
Neon Commerce Auth API
Neon Commerce Checkout API
Neon Commerce Client API
Neon Commerce Payouts API
Neon Commerce Prices API
Neon Commerce Pricing Sheet API
Neon Commerce Purchases API
Neon Commerce Status API
Neon Commerce Storefront API
Neon Commerce Subscriptions API