Connect API - version 5.0.10.43 - e0fd2903494d1ae48bab731f3fa0ca8dde49253c

Overview

What is OCAPI

The Omnichanel Component API, or OCAPI, was developed to create a single standard across Vista's sales channels. Eventually, OCAPI will replace V1 and V2 Connect, and become the sole API that Vista's sales channels use (unless they’re integrating with a third-party).

OCAPI development Status //TODO: need to update this for V1

Currently, OCAPI is in Beta. That means the following:

  • OCAPI's response models change frequently. This includes breaking changes. There's no guarantee existing OCAPI integrations will work after you upgrade Connect.

  • We aren't able to merge bug fixes to lower versions. The issue may be part of a model, or even endpoint, that is no longer used.

  • OCAPI requires some manual configuration that isn't required in V1 and V2.

  • In most cases, you'll need to install a Connect preview pack to integrate with OCAPI. This is a departure from V1/V2, which only uses preview packs in lab environments.

Differences between OCAPI and V1/V2

Compatibility

OCAPI uses similar concepts and flows to Connect V1/V2. For example, you still use endpoints to create orders, then different endpoints to update those order's parameters. Much of Connect's existing documentation, such as the API concepts, can be used to gain an understanding of OCAPI.

OCAPI's data models, however, differ substantially from V1/V2. Due to this, OCAPI isn't compatible with V1/V2. Call flows must be entirely contained to either OCAPI or V1/V2 endpoints. If an application has multiple call flows, some of those flows may be able to use OCAPI while others use V1/V2, as long as one flow doesn't rely on information or results from a different flow.

Polymorphic contracts

OCAPI's contracts are polymorphic. That means some responses have a type parameter, which determines what parameters are included or excluded in the response. In V1/V2, all parameters in a response's contract are returned, although only the relevant ones are populated.

Currently, OCAPI's reference documentation doesn't capture these contract changes. You'll need to identify them manually.