Skip to content

Latest commit

 

History

History
68 lines (68 loc) · 18.2 KB

AppSettingsReadme.md

File metadata and controls

68 lines (68 loc) · 18.2 KB
AppSetting Description
ApplicationInsightsSettings:InstrumentationKey Identifies the resouce you want to associate your telemetry data with. App Insights Overview
AvalaraSettings:AccountID AccountId associated to Avalara account
AvalaraSettings:CompanyCode Company name associated with Avalara
AvalaraSettings:CompanyID ComapanyID associated with Avalara
AvalaraSettings:LicenseKey Avalara License Key - Responses are mocked in Test and UAT if this isn't provided.
AvalaraSettings:BaseApiUrl Avalara Url to use based on environment (eg: https://rest.avatax.com/api/v2, https://sandbox-rest.avatax.com/api/v2)
StorageAccountSettings:BlobContainerCacheName Name of cache used with Azure blob storage
StorageAccountSettings:ConnectionString Connection string for the storage account. Found in Storage Account > Access Keys
StorageAccountSettings:BlobPrimaryEndpoint Url for the blob storage that is hosted in Azure. Found in Storage Account > Endpoints > Primary endpoint. Format is https://{STORAGEACCOUNT_NAME}.blob.core.windows.net/
StorageAccountSettings:BlobContainerNameQueue Unique name to signify queue within an account. Microsoft Reference
StorageAccountSettings:BlobContainerNameExchangeRates (Optional) Blob container that the exchange rates reside in defaults to
StorageAccountSettings:BlobContainerNameTranslations Blob container that translations reside in. By default only english translations are provide
CardConnectSettings:Authorization CardConnect specific token for authorization - Responses are mocked in Test and UAT if this isn't provided.
CardConnectSettings:AuthorizationCad CardConnect specific token for authorization (CAD) - Responses are mocked in Test and UAT if this isn't provided.
CardConnectSettings:BaseUrl URL used to connect to CardConnect (eg: cardconnect.com)
CardConnectSettings:CadMerchantID Merchant ID used for CAD, if applicable.
CardConnectSettings:Site Partner level grouping. (eg: https://.cardconnect.com), if applicable
CardConnectSettings:UsdMerchantID Merchant ID used for USD
CosmosSettings:DatabaseName Azure database resource name
CosmosSettings:EndpointUri Endpoint for your Cosmos instance. Can be found under Overview > URI. Is in the form https://{COSMOS_DB_ACCOUNT_NAME}.documents.azure.com:443/
CosmosSettings:PrimaryKey Can be found in Keys > Primary Key. Provides access to all the administrative resources for the database account Microsoft Reference
CosmosSettings:RequestTimeoutInSeconds How long before a request should be timed out
EasyPostSettings:APIKey Required on every request. Used to authenticate as basic user. API keys give full read/write access to your account
EasyPostSettings:FreeShippingTransitDays If the order has free shipping, this marks the transit days for the order
EasyPostSettings:NoRatesFallbackCost If no shipping rates are returned, use this as a fallback cost
EasyPostSettings:NoRatesFallbackTransitDays If no shipping rates are returned, use this as a fallback transit days
EasyPostSettings:USPSAccountId For each account used in EasyPost, add AccountID's to the settings. This setting is for USPS specifically
EnvironmentSettings:MiddlewareBaseUrl Base URL to the middleware API
EnvironmentSettings:BuildNumber The build number, automatically set during deploy
EnvironmentSettings:Commit The commit, automatically set during deploy
EnvironmentSettings:Environment Which environment this config will be used in (Test, UAT, Production).
EnvironmentSettings:TaxProvider Which tax service should be used for tax calculation (Avalara, Taxjar, or Vertex)
FlurlSettings:TimeoutInSeconds Timeout in seconds until Flurl (http client) will timeout
OrderCloudSettings:ApiUrl URL to connect to OrderCloud (eg: "https://sandboxapi.ordercloud.io" "https://stagingapi.ordercloud.io", or "https://api.ordercloud.io")
OrderCloudSettings:MiddlewareClientID ClientID used to interface with OrderCloud
OrderCloudSettings:MiddlewareClientSecret Client Secret used to interface with OrderCloud
OrderCloudSettings:IncrementorPrefix A prefix used in all orderIDs to create a distinct incrementor
OrderCloudSettings:WebhookHashKey Used to validate requests from webhooks are coming from OrderCloud
OrderCloudSettings:MarketplaceID The ID of the Marketplace
OrderCloudSettings:MarketplaceName The Name of your Marketplace. If you're a marketplace owner that is participating in commerce then any orders placed for your products will display MarketplaceName as the company that the user is purchasing from
SendGridSettings:ApiKey Api Key given by SendGrid (Optional but emails won't work without this)
SendgridSettings:FromEmail What account emails should be sent from (Optional but emails won't work without this)
SendgridSettings:CriticalSupportEmails (Optional) Comma delimited list of emails that should be contacted when criticial failures occur that require manual intervention
SendgridSettings:SupportCaseEmail (Optional) Email to send support cases to
SendgridSettings:BillingEmail (Optional) Email to send for payment, billing, or refund queries
		SendgridSettings:POUploadEmail					Email template used to send LMS team PO pdfs that were uploaded by Users using PO as payment
		SendgridSettings:CertOrderEmail					Email template used to send LMS team notifiations when User places an order containing certification products
		SendgridSettings:ToLMSTeamEmail				| The email of whom will recieve the notifications for certification and po emails 

| SendgridSettings:OrderSubmitTemplateID | (Optional) (Optional but required to send OrderSubmit emails) ID for the template to be used for OrderSubmit emails | | SendgridSettings:OrderApprovalTemplateID | (Optional but required to send OrderApproval emails) ID for template to be used for OrderApproval emails | | SendgridSettings:LineItemStatusChangeTemplateID | (Optional but required to send LineItemStatusChange emails) ID for template to be used for LineItemStatusChange emails | | SendgridSettings:QuoteOrderSubmitTemplateID | (Optional but required to send QuoteOrderSubmit emails) ID for template to be used for QuoteOrderSubmit emails | | SendgridSettings:NewUserTemplateID | (Optional but required to send NewUser emails) ID for template to be used for NewUser emails | | SendgridSettings:ProductInformationRequestTemplateID | (Optional but required to send ProductInformationRequest emails) ID for template to be used for ProductInformationRequest emails | | SendgridSettings:PasswordResetTemplateID | (Optional but required to send PasswordReset emails) ID for template to be used for PasswordReset emails | | SendgridSettings:CriticalSupportTemplateID | (Optional) but required to send CriticalSupport emails) ID for template to be used for CriticalSupport emails | | SmartyStreetSettings:AuthID | Authentication ID used to connect with SmartyStreet | | SmartyStreetSettings:AuthToken | Authorization token used to connect with SmartyStreet | | SmartyStreetSettings:RefererHost | HTTP Header to a hostname/IP address listed with the Website Key SmartyStreet Docs | | SmartyStreetSettings:WebsiteKey | A unique key that can be associated with one or more hostnames. SmartyStreet Docs | | UI:BaseAdminUrl | URL to the admin app used | | ZohoSettings:AccessToken | AccessToken used with Zoho (Optional but required for Zoho to work) | | ZohoSettings:ClientId | ClientID used with Zoho (Optional but required for Zoho to work) | | ZohoSettings:ClientSecret | ClientSecret used with Zoho and specified ClientID (Optional but required for Zoho to work) | | ZohoSettings:OrgID | OrgID used with Zoho (Optional but required for Zoho to work) | | ZohoSettings:PerformOrderSubmitTasks | Boolean that decides if order submit tasks should go through Zoho (Optional but required for Zoho to work) |