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 Assets API

The Assets API from Neon Commerce — 4 operation(s) for assets.

Neon Commerce Assets 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 Assets. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 4 paths, 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.

6 operations 4 paths 3 schemas 2 DELETE2 GET2 POST

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 Assets 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 6

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

Assets 6
POST
/assets/brand-images
Upload a brand image
createBrandImage body → 201400401
GET
/assets/brand-images
Returns the list of brand images associated with the environment
getBrandImages → 201401
POST
/assets/inventory-images
Upload an inventory image.
createInventoryImage body → 201400401
GET
/assets/inventory-images
Returns the list of inventory images associated with the environment
getInventoryImages → 201401
DELETE
/assets/brand-images/{imageId}
Mark a brand image as deleted.
deleteBrandImage 1 param → 204400401
DELETE
/assets/inventory-images/{imageId}
Mark an inventory image as deleted.
deleteInventoryImage 1 param → 204400401

Schemas 3

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

ErrorDetail
object
2 properties 2 required
Image
object
7 properties 7 required
APIError
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Neon Commerce publishes across the network.

Neon Commerce Account 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 Reports API
Neon Commerce Status API
Neon Commerce Storefront API
Neon Commerce Subscriptions API