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 One Orders API

Orders grouping donations, memberships, and store purchases.

Neon One Orders API is one of 12 APIs that Neon One publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 7 operations across 6 paths, and defines 4 schemas. It is described by OpenAPI 3.0.3, at version 2.11.

Requests are made against 2 base URLs: https://api.neoncrm.com/v2, https://trial.z2systems.com/v2.

7 operations 6 paths 4 schemas 1 DELETE1 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.11
Base URL
https://api.neoncrm.com/v2
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

Neon One Orders API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic Authentication. Username is the Neon CRM organization's Org ID; password is an API key generated for a system user under Settings User Management.

Paths & Operations 7

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

Orders 7

Orders grouping donations, memberships, and store purchases.

POST
/orders
Create an order
createOrder body → 200401
GET
/orders/{id}
Retrieve an order
getOrder 1 param → 200404
DELETE
/orders/{id}
Delete an order
deleteOrder 1 param → 200404
POST
/orders/calculate
Calculate the total of a prospective order
calculateOrder body → 200401
POST
/orders/search
Search orders
searchOrders body → 200429
POST
/orders/shippingMethods
List available shipping methods for an order
listShippingMethods body → 200401
POST
/orders/{orderId}/payments
Add a payment to an order (checkout)
createOrderPayment 1 param body → 200401

Schemas 4

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

SearchRequest
object
3 properties 2 required
Error
object
1 property
Order
OrderInput
object
5 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

neonone-orders-api-openapi.yml Raw ↑

Other APIs Neon One publishes across the network.

Neon One Accounts API
Neon One Campaigns API
Neon One Custom Fields API
Neon One Donations API
Neon One Events API
Neon One Households API
Neon One Memberships API
Neon One Properties API
Neon One Store API
Neon One Volunteers API
Neon One Webhooks API