Settings (API)

Search…
Settings (API)
Details of the VendorFuel API Settings value, which is defined by the Localized service.
Properties
Property
Type
Details
analytics
Boolean, object
Returns false if Google Analytics isn't configured under Settings > Analytics. 
authnet_id
Boolean, string
Returns false if AuthorizeNet gateway isn't configured under Payments settings.
authnet_public_key
Boolean, string
Returns false if AuthorizeNet gateway isn't configured under Payments settings.
gateway
Boolean
Returns false.
general
object
See general below.
image
object
Returns object of image dimensions.
square_location_id
Boolean, string
Returns false if SquareUp isn't configured under Payments settings.
store
object
See store below.
stripe_enabled
Boolean
Returns true/false based on if Enable as Primary CC Processor is checked under Payments for Stripe gateway.
stripe_pk
string
Returns Publishable Key under Payments for Stripe gateway.
general
Properties for Settings.general object.
Property
Type
Details
apiKey
string
Returns value in Settings > Plugin > API Key.
apiUrl
string
Returns value in Settings > Plugin > API URL.
btnText
string
Empty string.
cache
number
0
catSlug
string
Returns value in Settings > Plugin > Category Slug.
checkout
object
See checkout below.
confirmDelete
number, Boolean
Returns 0 or true, based on Settings > Plugin > Confirm Deletions.
confirmNavigate
number, Boolean
Returns 0 or true, based on Settings > Plugin > Confirm Navigation.
confirmationThumbs
number
0
customizedStyle
string
"vfuel01"
debug
number, Boolean
Returns 0 or true, based on Settings > Plugin > Enable Debug Log.
enableRecyclable
number, Boolean
Returns 0 or true, based on Settings > Plugin > Recyclable Options.
loggedInText
string
Empty string.
minJS
number
0
pagination
number, Boolean
Returns 0 or true, based on Settings > Plugin > Catalog Pagination.
productSlug
string
Returns value in Settings > Plugin > Product Slug.
redirectToCart
number
0
requireAddress
number, Boolean
Returns 0 or true, based on Settings > Plugin > Require Address.
showRating
number
0
checkout
Properties for Settings.general.checkout object.
Property
Type
Details
attention_option
Boolean
Returns value in Settings > Plugin > Additional Checkout Template Options > Attention.
company_name_option
Boolean
Returns value in Settings > Plugin > Additional Checkout Template Options > Company Name.
company_option
number
0
cost_center_option
Boolean
Returns value in Settings > Plugin > Additional Checkout Template Options > Cost Center.
issuing_office_option
Boolean
Returns value in Settings > Plugin > Additional Checkout Template Options > Issuing Office.
notes_option
Boolean
Returns value in Settings > Plugin > Additional Checkout Template Options > Notes.
purchase_order_option
Boolean
Returns value in Settings > Plugin > Additional Checkout Template Options > Purchase Order Number.
store
Property
Type
Details
default_customer_prefix
null
​
default_order_prefix
null
​
name
string
Returns value in Settings > Store > Store Name.
options
object
Returns object with true/false values based on the following keys:
"Admin Two Factor Authentication"
"Credit Line Default On"
"Disable Billing Address"
​"Disable Guests"
"Disable RMA"
"Force Role"
"Inventory System"
"Load Footer Template"
"Load Menu Nav Template"
"Verify Users" 
url
string
Returns value in Settings > Store > Store URL.
Favorites
User
Last modified 5mo ago
Copy link
Contents
Properties
general
store