List of cart include templates available in this store.
List of cart templates available in this store.
List of carts in this store.
List of checkout templates for this store.
List of coupons available in this store.
Configuration of this store's customer portal.
List of customers of this store.
List of downloadable products available in this store.
List of email templates for this store.
List of error entries for this store.
List of fraud protection measures enabled on this store.
List of gift cards available in this store.
List of hosted payment gateways enabled for this store.
List of item categories configured in this store.
List of payment method sets configured for this store.
POST here to resend the daily subscription webhook notification for this store.
List of receipt templates for this store.
List of reports for this store.
List of shipping methods supported by this store.
Version of this store.
Subscription settings for this store.
List of subscriptions created in this store.
List of taxes configured for this store.
List of template sets configured for this store.
List of transactions performed in this store.
List of user access resources for this store.
List of users with access to this store.
This resource.
This can only be set during store creation. Contact us if you need this value changed later.
If your store sells products which collect personal or sensitive information as product attributes, you may want to consider lowering your cart session lifespan. You can leave it as 0 to keep the default which is currently 43200 seconds (12 hours). The maximum allowed time is currently 259200 seconds (72 hours).
Set this to true if you would like each receipt sent to your customer to also be blind carbon copied to your store's email address.
The preferred configuration of your customer checkout experience, such as defaulting to guest checkout or requiring account creation with each checkout.
Two character ISO 3166-1-alpha-2 code for the country your store is located in. This will be used for calculating shipping costs if you sell shippable items.
Instead of displaying the Foxy Transaction ID, you can display your own custom display ID on your store's receipt and receipt emails. This JSON config determines how those display ids will work. The JSON supports the following fields: enabled
, start
, length
, prefix
, suffix
.
Configuration settings for the customer_password_hash_type in use. See the FoxyCart documentation for more details.
When saving a customer to FoxyCart, this is the password hashing method that will be used.
The date this resource was created.
The date this resource was last modified.
Set to true to turn on FoxyCart's multiship functionality for shipping items to multiple locations in a single order. See the FoxyCart documentation for more details.
The date of the first payment for this FoxyCart store subscription. This can be considered the go live date for this store.
Used for when you want to specify a different from email than your store's email address or when your store_email has a list of email addresses.
Set to true to prevent the currency symbol from being displayed (example: a points based checkout system).
Set to true to prevent the decimal characters from being displayed (example: a points based checkout system).
If this store is in development or if it has an active FoxyCart subscription and can therefore use a live payment gateway to process live transactions.
This settings makes your checkout page completely non-functioning. Your customers will see the maintenance notification language string instead. The default is false.
The default language for your store's cart, checkout, and receipt strings.
The locale code for your store's locale. This will be used to format strings for your store.
A url to your store's logo which may be used in your store's templates.
The postal code of your store. This will be used for calculating shipping costs if you sell shippable items.
Set to true to require all front-end add-to-cart interactions have a valid expires
property.
By default, FoxyCart sends customers back to the page referrer after completing a purchase. Instead, you can set a specific URL here.
The two character code for states in the United States. Other countries may call this a province. When a two character code isn't available, use the full region name. This will be used for calculating shipping costs if you sell shippable items.
Shipping rate signing ensures that the rate the customer selects is carried through and not altered in any way. If you're intending to make use of javascript snippets on your store to alter the price or label of shipping rates or add custom rates dynamically, disable this setting as it will block those rates from being applied. The default is false.
Used for determining the type of the customer address used when calculating shipping costs.
This is your single sign on url to redirect your users to prior to hitting the checkout page. See the FoxyCart documentation for more details.
If you'd like to configure your own SMTP server for sending transaction receipt emails, you can do so here. The JSON supports the following fields: username
,password
,host
,port
,security
. The security value can be blank, ssl
, or tls
This is a unique FoxyCart subdomain for your cart, checkout, and receipt. If you install a custom SSL certificate, this will contain a full domain such as store.yourdomain.com.
This is the email address of your store. By default, this will be the from address for your store receipts. If you specify a from_email, you can also put in multiple email addresses here, separated by a comma to be used when bcc_on_receipt_email is true.
The name of your store as you'd like it displayed to your customers and our system.
The URL of your online store.
This is the store version for this store. For more details about this version, see the store_versions property helpers which include changelog information.
The timezone of your store. This will impact how dates are shown to customers and within the FoxyCart admin.
Set a master password here if you would like to be able to check out as your customers without having to know their password.
Set to true to use HMAC cart validation for your store.
Set this to true if you have set up your DNS settings to include and spf record for FoxyCart. See the FoxyCart documentation for more details.
Set true to use the international currency symbol such as USD instead of the regional one like $.
Set to true when you plan to use a custom SSL certificate. If set to true, your store_domain must be a full domain.
Set this to true to redirect to your server before checkout so you can use our single sign on feature and log in your users automatically to FoxyCart or if you want to validate items before checkout.
Set this to true to POST encrypted XML of your order to the webhook url of your choice.
This is the key used to encrypt your webhook data. It is also used as the legacy API key and the HMAC cart encryption key.
This is the url of the webhook endpoint for processing your store's webhook. See the FoxyCart documentation for more details.
Generated using TypeDoc
List of custom attributes of this store.