Architecture

OrderCloud is a cloud-hosted B2B, B2C, and B2X eCommerce platform exposed entirely via a RESTful API. It provides a foundation for developing custom, secure, and scalable eCommerce solutions.

Benefits of a RESTful API

Whether it is the central hub of a mobile purchasing app or one component of a larger microservices-based solution, a RESTful API provides clear advantages over other approaches.

Language agnostic

OrderCloud is language agnostic and API-first. Access all of the domain through an OpenAPI specification by using any of our SDKs or by generating your own clients with your preferred development stack. Releases are automatic and non-breaking, providing a clear boundary between our code and yours. Modern web and mobile front-end frameworks work with JSON-over-HTTP services that follow RESTful patterns.

Scalability

Unlike on-premise solutions, server infrastructure and data security are managed for you. Start small and scale up as your business usage grows. Unlike SaaS products, you can customize user interfaces and workflows extensively.

Best-of-breed

OrderCloud integrates with other similarly architected services. In a microservices architecture, best-of-breed solutions are assembled from specialized components rather than built from scratch. OrderCloud provides B2B, B2C, and B2X eCommerce and Order Management functionality, with a data model refined since 1999.

• OAuth 2.0 - OrderCloud API authentication is based on the OAuth 2 specification and supports multiple workflows, including Single Sign-On (SSO).
• SSL - API access is only allowed via HTTPS; connections on port 80 are refused.
• Environments - In addition to the production environment, OrderCloud exposes two test environments: Sandbox (never restored) and Staging (restored weekly from production) to enable developers to deploy to production with confidence.
• OpenAPI 3.0 - The OpenAPI specification is generated from source code and used to generate the portal, documentation, and SDKs. It uses the latest OpenAPI features to provide an accurate and programmatically useful description of every endpoint, model, and property.

Flexibility over features

OrderCloud evolves continuously. Rather than trying to be experts at everything, we focus on providing a flexible commerce engine. The best commerce solutions are assembled from distributed, best-in-breed components rather than built from scratch or offered as a one-size-fits-all SaaS solution.

Extensible everywhere

Virtually every model in OrderCloud can be extended to meet your specific needs. This flexibility, combined with native assignment-based relationships and the Webhooks system, makes it easy to keep legacy systems in sync while adding powerful B2B commerce functionality.

Filtering buyers using XP

This example returns all buyers in the 'USNW' sales region:

HTTP:

GET https://sandboxapi.ordercloud.io/buyers?filters=xp.MySalesRegion=USNW
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...
Content-Type: application/json; charset=UTF-8

JavaScript:

import { Buyers } from "ordercloud-javascript-sdk";

Buyers.List({ filters: { 'xp.MySalesRegion': 'USNW' } })
  .then(buyerList => {
    console.log(buyerList);
  })
  .catch((ex) => console.log(ex));

TypeScript:

import { ListPage, Buyer, Buyers, OrderCloudError } from "ordercloud-javascript-sdk";

Buyers.List({ filters: { 'xp.MySalesRegion': 'USNW' } })
  .then((response: ListPage<Buyer>) => {
    console.log(response);
  })
  .catch((ex: OrderCloudError) => console.log(ex));

C#:

using OrderCloud.SDK;

try
{
  var ocClient = new OrderCloudClient(...);
  ListPage<Buyer> response = await ocClient.Buyers.ListAsync(filters: new Dictionary<string, string>
  {
    ["xp.MySalesRegion"] = "USNW"
  });
} catch(OrderCloudException ex)
{
  Console.WriteLine(ex.Message);
}

Warning: OrderCloud allows storing any string value in properties that accept strings. Any vulnerabilities that might arise in a customer's application due to improper encoding are the responsibility of the application developer. Use proper HTML encoding in your frontend wherever it is needed.