Developer Resources

Build secure, scalable enterprise applications on the Open Commerce™ Experience API Gateway and Commerce Service Bus (CSB).

Technology to
Accelerate Development

Application development for consumer experiences such as mobile, web, kiosk, connected car, and more, is simplified through the Experience API, which offers purpose-built endpoints for the data and workflows required to deliver frictionless, intuitive, industry-specific digital storefront solutions.

Leverage the Open Commerce APIs and/or the Open Commerce AMQP compliant CSB to connect with existing Open Commerce integrations into best-in-class POS systems, including NCR, Verifone, and Gilbarco, and best-in-class digital service providers, such as Hatch, Paytronix, Koupon Media, plus many more, and best-in-class payment processors and mobile wallets, including PayPal, Venmo, Chase Pay, Apple Pay, Google Pay, Samsung Pay, FirstData, plus many more.

Experience API

Build robust digital commerce applications leveraging pre-existing integrations with best-in-class providers across POS, loyalty, offers, payments, and more. Connect into the entirety of the Application Server offering, including the CSB, industry-specific gateways, the Open Commerce Command Center for Quality of Service monitoring, and more. Pub/Sub capabilities for Open Commerce Experience API endpoints enable a more optimized approach to data synchronization across enterprise systems. Pub/Sub delivers low-latency, durable messaging that helps reduce the time and complexity of systems integration.

View Enterprise Technology
image

Commerce Service Bus

The Open Commerce CSB is at the core of how all services communicate. Unlike an off-the-shelf Service Bus, the Open Commerce CSB was purpose-built to the specific and unique payment, loyalty, offers, order-ahead, self-checkout, and frictionless commerce transaction flows of your retail environment with Conexxus, IFSF, and other global standards at the core.

The CSB, with bidirectional pub/sub communications, becomes central and critical in empowering your retail organization to continue innovating rapidly in digital and big data, collect analytics across your vendor services, deliver real-time insights to the business, to keep pace with the evolving demands and preferences of the consumer, and to defend and grow your market share.

View Enterprise Technology
image

Experience API Capabilities

Design, build, test, and deploy secure digital commerce applications utilizing the following capabilities:

Consumer Identity
Management

Manage sign-in, sign-up, multi-factor authentication, password reset, and multi-channel identity.

Consumer Profile
& Demographics

Manage uniquely identifiable information for each consumer, for use in a consumer profile or enriching analytics.

App
Configuration

Query for general app configuration settings and geo-targeted configurations for app experience personalization.

Payment Method
Vaulting

Securely add payment methods to the consumer’s digital wallet.

Pay-at-Pump
Orchestration

Manage the complete workflow for all the steps required to complete a pay-at-pump transaction with all leading POS providers.

Pay-in-Store
Orchestration

Manage the complete workflow for all the steps required to complete a pay-in-store transaction with all leading POS providers.

Scan-and-Go
Orchestration

Manage the complete workflow for all the steps required to empower consumers with a mobile self-checkout experience, integrated with all leading POS providers.

Frictionless
Orchestration

Manage the complete workflow for all the steps required to empower consumers with a frictionless checkout experience, integrated with all leading POS providers.

Order-Ahead
Orchestration

Manage the complete workflow for all the steps required to complete an order-ahead transaction with all leading POS providers that support food ordering capabilities.

Transaction
Status

Query for the current state of a transaction, including reserving the pump, pre-authorization, pump enablement, fueling, fueling complete, settlement, and digital receipt.

Transaction
History

Query for all payment transactions over a specified range for a consumer.

Loyalty
Integration

Query for the available loyalty and rewards data and associated media pertaining to the consumer’s loyalty account.

Offers Integration

Query for the available offers data and associated media pertaining to the consumer, consumer’s location, and available deals.

Consumer Feedback

Enable consumers to give direct feedback to the operators.

Site Data

Query for the available site information pertaining to fuel, store, car wash, geo, or other custom attributes.

Reporting

Query to pull aggregate data for compiling reports by specified range and attributes.

Quality of Service

Query for real-time quality of service alerts pertaining to sites, integrations, and platform health and status.

GraphQL Primer

GraphQL is a query language for APIs and a runtime for fulfilling those queries with your existing data. GraphQL provides a complete and understandable description of the data in your
API, gives clients the power to ask for exactly what they need
and nothing more, makes it easier to evolve APIs over time, and enables powerful developer tools.

Why GraphQL for Open Commerce?

  • In GraphQL, the specification for queries are encoded in the client rather than the server. These queries are specified at field-level granularity. In the vast majority of applications written without GraphQL, the server determines the data returned in its various scripted endpoints. A GraphQL query, on the other hand, returns exactly what a client asks for and no more. This also simplifies managing backwards compatibility.
  • GraphQL is strongly-typed. Given a query, tooling can ensure that the query is both syntactically correct and valid within the GraphQL type system before execution, (i.e. at development time) and the server can make certain guarantees about the shape and nature of the response.
    This makes it easier to build high quality client tools.
  • GraphQL is introspective. Clients and tools can query the type system using the GraphQL syntax itself. This is a powerful platform for building tools and client software, such as automatic parsing of incoming data into strongly-typed interfaces.

Partner Integration Guide GraphQL Schema Examples

The purpose of the Partner Integration Guide is to enable partners to build customer experiences that utilize the capabilities of Open Commerce. Stuzo has built a secured GraphQL API to allow for integration from any application or service. The API exposes the following functionality:

  • Customer sign in and authentication
  • Customer sign up and onboarding
  • Customer account and profile management
  • Wallet management
  • Transactions at the pump
  • Transactions in store
  • Location management
  • Customer feedback
  • Customer support

Example Schema

Partners & Integrations

Stuzo works with industry-leading partners. See all Open Commerce partners and integrations here:

Contact Us for API Access

Please use the form below if you’re interested in accessing the Open Commerce API schema documentation.

By submitting the form you agree to receive
future periodic email communication from Stuzo.