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

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Neon Commerce

Neon Commerce Storefront API

The Storefront API from Neon Commerce — 9 operation(s) for storefront.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 17 operations across 9 paths, and defines 11 schemas. It is described by OpenAPI 3.1.0, at version 1.

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

17 operations 9 paths 11 schemas 3 DELETE6 GET4 POST4 PUT

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 Storefront 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 17

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

Storefront 17
POST
/storefront/items
Create items
createStorefrontItems body → 201400401
POST
/storefront/offer-groups
Create an offer group
createStorefrontOfferGroups body → 201400401
POST
/storefront/offers
Create offers
createStorefrontOffers body → 201400401
GET
/storefront/offers
Get offers
getStorefrontOffers 3 params → 200400401
DELETE
/storefront/item/{code}
Delete an item
deleteStorefrontItem 1 param → 200400401
GET
/storefront/item/{code}
Get an item by code
getStorefrontItem 1 param → 200400401
PUT
/storefront/item/{code}
Update an item by code
updateStorefrontItem 1 param body → 201400401
DELETE
/storefront/offer/{sku}
Delete an offer
deleteStorefrontOffer 1 param → 200400401409
GET
/storefront/offer/{sku}
Get an offer by SKU
getStorefrontOffer 1 param → 200400401
PUT
/storefront/offer/{sku}
Update an offer by SKU
updateStorefrontOffer 1 param body → 200400401
DELETE
/storefront/offer-group/{code}
Delete an offer group
deleteStorefrontOfferGroup 1 param → 200400401
GET
/storefront/offer-group/{code}
Get an offer group by code
getStorefrontOfferGroup 1 param → 200400401
PUT
/storefront/offer-group/{code}
Update an offer group by code
updateStorefrontOfferGroup 1 param body → 201400401
GET
/storefront/prices
Get localized pricing by IP address.
getRegionalPricingByIpAddress 1 param → 200400401
GET
/storefront/theme
Get a storefront theme
getTheme → 201400401
PUT
/storefront/theme
Update the theme for a storefront
updateTheme body → 200400401
POST
/storefront/callbacks
Register a URL to handle events throughout the storefront and checkout flow.
subscribeToCallbacks body → 201400401

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are Offer (15 properties), Theme (15 properties), OfferText (7 properties), APIError (5 properties). Each schema is shown below with its type and property counts.

ItemText
object
A Neon localized text object for an Item. See [here](https://neonpay.readme.io/docs/text-localization) for more details.
3 properties 2 required
ErrorDetail
object
2 properties 2 required
Offer
object
15 properties 10 required
PlayerInventory
array
OfferGroupText
object
A Neon localized text object for an Offer Group. See [here](https://neonpay.readme.io/docs/text-localization) for more details.
4 properties
Item
object
Items are the base unit of any offer, like gems or gold. Offers are made up of items with quantities (e.g. 500 gold).
3 properties 3 required
OfferGroup
object
Offer groups are used to group and display offers in a storefront.
3 properties 3 required
Theme
object
15 properties 13 required
APIError
object
5 properties 2 required
OfferItemText
object
A Neon localized text object for an Item within an Offer. See [here](https://neonpay.readme.io/docs/text-localization) for more details.
2 properties
OfferText
object
A Neon localized text object for an Offer. See [here](https://neonpay.readme.io/docs/text-localization) for more details.
7 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Neon Commerce publishes across the network.

Neon Commerce Account API
AE Profile APIs.io
Neon Commerce Assets API
AE Profile APIs.io
Neon Commerce Auth API
AE Profile APIs.io
Neon Commerce Checkout API
AE Profile APIs.io
Neon Commerce Client API
AE Profile APIs.io
Neon Commerce Payouts API
AE Profile APIs.io
Neon Commerce Prices API
AE Profile APIs.io
Neon Commerce Pricing Sheet API
AE Profile APIs.io
Neon Commerce Purchases API
AE Profile APIs.io
Neon Commerce Reports API
AE Profile APIs.io
Neon Commerce Status API
AE Profile APIs.io
Neon Commerce Subscriptions API
AE Profile APIs.io
#Storefront
← Back to N APIs
API Details
ID
neon-commerce:neon-commerce-storefront-api
Base URL
https://api.neonpay.com
Docs
https://docs.neonpay.com/reference
Provider
Neon Commerce
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network