Chord OMS
...
Chord OMS Overview
Products

Digital Products

9min

Introduction

Digital Products facilitate a customer's ability to buy and redeem credits. Unlike store credit or gift cards, which represent currency, digital purchases represent singular units. Like a token at an arcade, the customer can redeem their purchase in exchange for something.

Chord OMS supports selling Digital Products out of the box. The OMS does not dictate how digital purchases are redeemed or what they are redeemed for, so there is a lot of flexibility around how they can be used. For example:

  • a digital purchase can be redeemed in external applications via the API (in exchange for something within that application)
  • a single digital product SKU can generate one or more digital purchases upon order completion (e.g. five tokens for one purchase)
  • be delivered via email

Glossary

Digital Product

A product that, when purchased, generates one or more Digital Purchases. It is powered by a traditional product SKU that it converts a Digital Product. A Digital Product stores:

  • the product's SKU (variant)
  • the quantity of Digital Purchases to generate when that SKU is purchased
  • additional metadata for anything related to the digital purchase of that SKU (e.g. a static URL that customers are buying access to)

Digital Purchase

The individual token that can be redeemed. It stores:

  • whether or not it has been redeemed
  • additional metadata for anything related to the specific digital purchase (e.g. an individual identifier of a purchased report)

Technical Documentation

See the API Reference for the endpoints to:

  • get all digital purchases for a given customer
  • get a single digital purchase
  • redeem and optionally update a digital purchase
  • update the metadata for a digital purchase

Setup

Be sure to update your store's website code to pass the channel parameter with the value of digital when creating a checkout via the quick_checkouts endpoint. This adjustment is required to ensure proper handling on the backend.

  1. Set DIGITAL_PURCHASES_ENABLED in your store settings to enabled
  2. Create a new product (and variants if required) that will be set up to be a Digital Product.
  3. Navigate to the Products tab and click the Digital Products button (on the top right)
  4. Add a new Digital Product by adding:
    • the SKU to be converted to a digital product
    • the quantity of Digital Purchases created for that variant, and
    • any metadata that would be helpful store on the Digital Product itself

Usage

  1. The Digital Purchase(s) will automatically be created by checking out with the associated SKU.
  2. A Digital Purchase can be redeemed via a dedicated endpoint with (optional) additional metadata.

Advanced Features

Auto-redemption

The payload below can be used to add additonal data to digital purchase on checkout. To automatically redeem the digital purchase on the order complete, add "auto_redeem": trueto the metadata.

{ "line_items_attributes": [ { "sku": "product-2", "quantity": 1, "digital_purchases_attributes": [ { "metadata": { "additonal": "data", } }, { "metadata": { "auto_redeem": true } } ] } ] }