Store Variables

introduction you can use store variables to store credentials and configuration data, which your platforms retrieve when needed a few prominent types of store variables exist in the chord platform, each with its use cases below, they are grouped by areas/programs what are store variables? store variables are configuration settings available to your store 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 store variables is not hardcoded in your application; rather, they are dynamic and can be changed based on your program's environment analytics analytics variables help you with the process of interpreting and communicating significant patterns in data variable values description segment write key when creating an account for our tenant excluded tracking preferences example ‘iterable, google analytics’ list of comma separated values for segment destinations that should not receive track events, even if the user permits it fulfillment services (3pl) a fulfillment service is a third party warehouse that prepares and ships your orders for you variable values descripti on easypost key external tracker enabled or disabled requires an easypost account to track packages with a value of enabled narvar enabled true or false either true or false if you are using narvar to track packages non fulfillable skus comma separated list of skus skus included in this list will not be sent for fulfillment export order fulfillments enabled or disabled this will allow the admin user to download their ready order fulfillments into a csv as well as upload manually fulfilled shipments to be updated in the oms shipstation shipstation api key found in your shipstation account under api keys shipstation api secret found in your shipstation account under api keys shipstation store username provided when you create a shipstation account shipstation store password provided when you create a shipstation account shipstation store id provided when you create a shipstation account wine shipping wine shipping password provided when creating a wineshipping account wine shipping customer no wine shipping api host api test wineshipping com on staging and api wineshipping com on production wine shipping user key wine shipping api version if not provided it will default to v3 capacity capacity client code all settings will be provided by capacity capacity api endpoint example http //wservices capacityllc com 105 all settings will be provided by capacity capacity ftp password example go all settings will be provided by capacity capacity ftp port all settings will be provided by capacity capacity ftp url all settings will be provided by capacity capacity ftp username all settings will be provided by capacity capacity http timeout value the default value is 5 seconds capacity password all settings will be provided by capacity capacity owner id all settings will be provided by capacity capacity rest api key all settings will be provided by capacity capacity rest client code all settings will be provided by capacity capacity rest client id all settings will be provided by capacity capacity rest client secret all settings will be provided by capacity capacity rest uri all settings will be provided by capacity order desk notifications host example tracking mystore com the oms will use this to build the shipment notification url order desk api key information available when you create an orderdesk account order desk store id information available when you create an orderdesk account shiphero/shipmonk ship hero auth token information available when you create an shiphero account ship hero refresh token information available when you create an shiphero account shipping methods shipping methods are the rates and services that your customers can choose from at checkout deliverr deliverr shipping exclusive true or false only deliverr method will display at checkout if set to true deliverr enabled enabled or true accelpay accelpay shipping exclusive true only accelpay shipping method will display in checkout if set to true accelpay enabled enabled or true shipping settings used to help you set up and manage your store's shipping rates, threshold and more free shipping threshold example 30 if customer reaches $30 free shipping is enabled free shipping unit weight free shipping can be enabled with either a dollar or weight threshold by default, the api expects a dollar based shipping threshold that is enabled by setting free shipping threshold with no other configuration necessary stores that prefer to use package weight as a qualification mechanism can set free shipping unit to weight, and the threshold value will be compared against the value returned by the package weight hold shipment window in minutes example 90 (in minutes) default is 60 in minutes the window in which an order can be canceled before it is pushed to the warehouse shipping flat rate example 7 99 this variable defines the price of your shipping rate single shipment priority example enabled allows for optimization of fulfillment for all items in an order from a single stock location tracking packages a tracking number or tracking code is a unique number assigned to packages , allowing you to monitor the parcel's movement between your warehouse and your customers variable values description easypost key external tracker enabled or disabled requires an easypost account to track packages with a value of enabled narvar enabled true or false either true or false if you are using narvar to track packages transactional emails a transactional or triggered email is a personalized email sent to your customers directly responding to their online interaction they typically have a functional purpose, like reminder emails about their subscriptions, back in stock product, shipping notifications, or updating customers about their orders variable value description abandoned cart email enabled or disabled this variable allows the system to email your customers after they add items to their bag and do not finalize checkout by either closing the browser or leaving it open for a minimum of 60 minutes this requires the email template to exist in your cms and be published (if set to enabled) subscription default reminder days example 15 value is in days this variable allows the system to email your customers before their current subscription ships actionable date this requires the email template to exist in your cms and be published (if set to enabled) subscription last chance reminder days example 5 value is in days this variable allows the system to email your customers offering them a last attempt to edit their subscription before it ships actionable date this requires the email template to exist in your cms and be published (if set to enabled) schedule gift card reminders comma separated list of integers if present, the oms will be sending \<today> + x days, where x is an integer in the list for example, if the value is “15,30”, two gift card reminders will be created with a remind at date of 15 days and 30 days from now referral prompt email enabled or disabled this variable allows the system to email your customers after they place an order to remind them they can tell their friends about your business to earn some rewards this requires the email template to exist in your cms and be published (if set to enabled) referral reward confirmation email enabled or disabled this variable allows the system to email your customers after their friends placed an order using the referral program this email to remind them that they have successfully earned some rewards this requires the email template to exist in your cms and be published (if set to enabled) transactional emails enabled enabled or disabled when set to disabled, chord will not deliver any transactional emails this is useful for stores that want to send their transactional emails externally (klaviyo templates, for example) order confirmation suppression list example comma delimited list of channels if an order is placed in one of provided channels, order and shipment confirmation emails are bypassed cross sell email enabled or disabled when enabled oms will send out an email using a "cross sell email" template to the email associated with the order stock requests notification enabled enabled or disabled this variable allows you to send email to your customers who are on the waiting list to let them know an item is back in stock this requires the email template to exist in your cms and be published (if set to enabled) payment processors 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 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 management a content management system, also known as cms, is used to manage your online store content, such as products, prices and much more sanity sanity dataset production or staging the name of the dataset within the project holding the entries to sync with oms sanity project id the name of the project holding the entries to sync with oms sanity token security token oms uses to authenticate with sanity when syncing entries sanity webhook secret security token oms uses to authenticate webhooks with sanity contentful contentful environment master for production staging for test environment ensure to match the name that you have in your space in contentful contentful host cdn contentful com contentful space id space id found in contentul under settings > general settings contentful webhook secret found in contentful under webhooks settings contentful access token found under settings > api keys content delivery api access token authentication passwordless authentication magic magic api key example sk live xxxxxx provided by chord stytch auth provider stytch stytch project id used for stytch authentication stytch secret used for stytch authentication styctch project used for stytch authentication stytch env live or test if staging taxes you can use avalara or stripe automated taxes stripe taxes stripe automatic taxes enabled enabled or disabled if using stripe automated taxes, enabled is required skip stripe tax recalculation enabled or disabled determines whether stripe tax caching will be used for automatic subscription installment orders tax free channels tax free channels example edi, or wholesale channels are defined in the oms avalara avatax account account id (numeric) avatax enabled or disabled avatax company code provided when you create your avalara account avatax license key provided when you create your avalara account avatax log enabled true or false avatax origin example { "line1" "33 irving pl", "line2" "", "city" "new york", "region" "ny", "postalcode" "10003", "country" "us" } address of your business avatax tax calculation enabled true or false true is suggested if using avalara affiliate program an affiliate program is an agreement in which your business pays an influencer ('the affiliate') a commission for sending traffic and sales their way affiliate affiliate commission percentage integer the default commission amount paid on affiliate orders or line items affiliate reversals enabled enabled or disabled when enabled, when a refund is processed for an order with an associated affiliate payment, a transfer reversal will occur to reverse the commission payment affiliate transfer time in minutes integer number of minutes after a payment is captured or a return is processed to wait before initiating the transfer or reversal with stripe connect referral programs a referral program allows customers to earn promotional reward credits for future purchases by referring friends/family to your site referral referral host url of host who provides the referral program i e , www chord com usually the tenants’ site referral credit amount amount given to referrer i e , 10 the person who refers will get that amount when the person they referred places an order referral annual limit annual limit the referrer is limited to referring i e , 50 referral mailer delivery delay select a number of days before sending the above email after a customer places an order referral prompt email either enabled or disabled referral reward confirmation email either enabled or disabled email (smtp) smtps are your outgoing mail server emails at chord we are using mailgun or sendgrid smtp smtp domain example smtp mailgun org smtp sendgrid org smtp password provided when setting up a new domain in mailgun or sendgrid smtp username provided when setting up a new domain in mailgun or sendgrid smtp address provided when setting up a new domain in mailgun or sendgrid subscriptions for emails associated with subscriptions please refer to transactional emails section subscriptions free shipping for subscriptions disabled or enabled to get free shipping for subscription orders stale subscription threshold days integer 180 the number of days that an incomplete subscription order will remain in current state before it is automatically canceled subscription maximum reprocessing counter integer maximum payment retry that can be executed after the last successful subscription installment after that time, the subscription will be auto canceled cross/post sell a post sales process is a series of tasks that you perform after your customer buys a product or service from you cross sell cross sell email enabled or disabled when enabled oms will send out an email using a "cross sell email" template to the email associated with the order cross sell post checkout enabled or disabled allow your customer to be given the opportunity to cross sell after checkout order cross sell time in minutes any integer but defaults to 15 used to define the cross sell ends at property in orders api response channels order channels are a way to distinguish and organize orders by the way in which they pass through the oms automatic approval channels comma delimited list of channels example chord,subscription, batch orders that belong to a specified channel will bypass the manual approval process that can be enabled on certain shipping zones order confirmation suppression list example comma delimited list of channels if an order is placed in one of provided channels, order and shipment confirmation emails are bypassed tax free channels example edi, or wholesale channels are defined in the oms bundles sku/bundles validate part line items enabled/disabled when enabled, oms will prevent a customer from adding a part to a bundle unless explicitly permitted in contentful see the note sync sku based bundles enabled/disabled when disabled, kits from contentful will no longer create sku based bundles this is to switch to the new dynamic bundles importer the importer allows you to import specific 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 passport is the international shipping carrier for your international sites passport value notes passport shipping enabled enabled or disabled enables when you create a passport account miscellaneous variable values description include stock availability count enabled/ disabled include available stock quantity on certain api endpoints