website logo
Navigate through spaces
Chord Commerce
⌘K
Getting Started
CMS
Data
OMS
Integrations
👩‍💻Developer Tools
Shopify
Docs powered by archbee 
15min

Environment Variables

Introduction

You can use Environment variables to store credentials and configuration data, which your platforms retrieve when needed.

A few prominent types of environment variables exist in the Chord Platform, each with its use cases. Below, they are grouped by areas/programs.



What are Environment Variables

Environment variables are variables available to your program/application dynamically during runtime. These variables comprise a name and a value. The value can come from various sources such as — third-party API, URLs, text files, etc.

The value of these environment variables is not hardcoded in your application; rather, they are dynamic and can be changed based on your program's environment.





Analytics

Fulfillment Services - 3PLs

Shipping Methods

Shipping Settings

Tracking Packages

Transactional Emails

Payment Service Providers

A payment service provider (PSP) is a third-party company that provides payment services to your business for your online payment methods.



SQUARE



SQUARE_LOCATION_ID

Can be found in Square --> Account

SQUARE_ENVIRONMENT

either sandbox or production

SQUARE_APP_ID

Can be found in Square --> Account

SQUARE_ACCESS_TOKEN



Can be found in Square --> Account





STRIPE





STRIPE_ALLOWED_CALLBACK_URLS





Example: https://www.chord.co.

In order to enable checkout (Redirect to Stripe) the URL must be listed as a value: i.e., , https://www2.domain.com

STRIPE_API_KEY

sk_test_xxxxx for Staging environment

sk_live_xxxxxx for Production

keys found in the customer's dashboard https://dashboard.stripe.com/apikeys

STRIPE_STATEMENT_DESCRIPTOR

 Example: Chord.co

When your customer get charged, the value provided here will appear on their bank statement

STRIPE_WEBHOOK

enabled or disabled

enabled (to allow for asynchronous events like checkout)

STRIPE_WEBHOOK_SECRET

 

Key (The endpoint’s secret, used to generate webhook signatures. Only returned at creation.)

STRIPE_SHIPPING_ADDRESS_MESSAGE



The message you are typing here is what will display to your customers under Shipping Address at checkout

STRIPE_SUBMIT_MESSAGE



The message you are typing here is what will display to your customers under Billing Address at checkout

STRIPE_ALLOWED_COUNTRIES

Example: US, CA, IT, FR

Allows for shipping to countries you select

STRIPE_PHONE_NUMBER_COLLECTION_ENABLED

enabled or disabled

If enabled, your customers will have to provide their phone numbers at checkout. 

STRIPE_CHECKOUT_COMPLETED_WEBHOOK_ENABLED

enabled or disabled

Only used for POS Orders- Consumes the payment_intent.succeeded event from Stripe.

STRIPE_CHECKOUT_EXPIRATION_IN_MINUTES

60

Minimum value is an hour (in minutes)

STRIPE_CHECKOUT_EXPIRED_WEBHOOK_ENABLED

enabled or disabled

This allows for enabling cart abandonment feature

STRIPE_CANCEL_URL

cart

This value will be appended to the stripe base callback url. For example if callback url is https://mystore.com then the cancel url will be https://mystore.com/cart

STRIPE_REDIRECT_URL_LOCALE_ENABLED

enabled or disabled

when enabled OMS will add the locale to stripe callback url, for example https://mystore.com/en-US/order/confirmation

STRIPE_INVOICE_DAYS_UNTIL_DUE

Example: 30

For stores using Stripe Invoices, allows stores to configure the number of days until payment is due on an invoice.

STRIPE_PK_KEY

Example:

sk_test_xxxxxxxx for staging

sk_live_xxxxx for Production

Publishable keys found in Stripe https://dashboard.stripe.com/test/apikeys

STRIPE_PRODUCT_SYNC

enabled or disabled

When enabled, the OMS product catalog will be synced with Stripe. This is required for Payment Links to work

STRIPE_AUTOMATIC_TAXES_ENABLED

enabled or disabled

to allow automatic taxes to collect the right amount of tax wherever you sell your goods.

STRIPE_PROMOTION_CONSENT_COLLECTION

enabled or disabled

Enabled required. If enabled, your customers will see an option to check to receive promotional offers at checkout

STRIPE_SUBSCRIPTION_CONSENT_MESSAGE





STRIPE_CART_RECOVERY_PROMO_CODE

Example: promo_1Lb9J2IkikXvVt8cphQDHAL8

The ID of the coupon created with the Stripe Dashboard. This is used during checkout abandoned flow, the promo code should be applied in checkout when customers click on abandoned checkout link. 

STRIPE_SUCCESS_URL_FORMAT 

path 

if this is set to a value different than "path" the stripe success url will look like:

mystore.com/order/confirmation?number=OrderNumber&checkout_session_id={CHECKOUT_SESSION_ID}

where by default order number and checkout session id are part of the URL path:

mystore.com/order/confirmation/number/{CHECKOUT_SESSION_ID} 

STRIPE_STATEMENT_DESCRIPTOR

 

Example: chord

defaults to OMS Store name. This value is sent to stripe when creating a payment. See stripe docs

STRIPE_SUBSCRIPTION_CONSENT_REQUIRED

enabled or disabled

Default value is "disabled". When set to "enabled" stripe checkout will require accepting terms of service before accepting orders with a subscription.



See stripe docs

STRIPE_CHARGE_EXPIRED_WEBHOOK_ENABLED

enabled or disabled

Auto-void expired payments on the OMS when Stripe sends us the charge.expired event

Content Managements

Authentication

Taxes

Affiliate Program

Referral Programs

SMTP

Subscriptions

Cross/Post-Sell

OMS Order Channels

SKU/Bundles

Importer Settings

The Importer allows you to import certain data, such as Orders, Products, Customers, Gift Cards, and Subscriptions





GIFT CARD IMPORTER





GIFT_CARD_IMPORTER_CREATE_STORE_CREDIT

enabled or disabled

When importing gift cards, states whether OMS should create associated store credits. If disabled, OMS will not create new credits but will instead try to find a matching existing store credit.

GIFT_NOTES_ONLY_WITH_ASCII

enabled or disabled



Error Reporting



The SENTRY_DSN variable allows you to add your Sentry account information if you want to monitor and get alerts sent to your account.



Error Reporting

SENTRY_DSN

You can find the DSN in your Sentry project settings by navigating to [Project] > Settings > Client Keys (DSN) in .

Set this to capture and record errors in Sentry.



International











Updated 11 Mar 2023
Did this page help you?
Yes
No
UP NEXT
Integrations
Docs powered by archbee 
TABLE OF CONTENTS
Introduction
What are Environment Variables
Analytics
Fulfillment Services - 3PLs
Shipping Methods
Shipping Settings
Tracking Packages
Transactional Emails
Payment Service Providers
Content Managements
Authentication
Taxes
Affiliate Program
Referral Programs
SMTP
Subscriptions
Cross/Post-Sell
OMS Order Channels
SKU/Bundles
Importer Settings
Error Reporting
International