Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

child?: Core.Graph
curie: "fx:default_store"
links: { fx:attributes: Backend.Rels.Attributes; fx:cart_include_templates: CartIncludeTemplates; fx:cart_templates: CartTemplates; fx:carts: Carts; fx:checkout_templates: CheckoutTemplates; fx:coupons: Coupons; fx:customer_portal_settings: Backend.Rels.CustomerPortalSettings; fx:customers: Customers; fx:downloadables: Downloadables; fx:email_templates: EmailTemplates; fx:error_entries: ErrorEntries; fx:fraud_protections: FraudProtections; fx:gift_cards: GiftCards; fx:hosted_payment_gateways: HostedPaymentGateways; fx:item_categories: ItemCategories; fx:payment_method_sets: PaymentMethodSets; fx:process_subscription_webhook: ProcessSubscriptionWebhook; fx:receipt_templates: ReceiptTemplates; fx:reports: Reports; fx:store_shipping_methods: StoreShippingMethods; fx:store_version: StoreVersion; fx:subscription_settings: SubscriptionSettings; fx:subscriptions: Backend.Rels.Subscriptions; fx:taxes: Taxes; fx:template_sets: TemplateSets; fx:transactions: Backend.Rels.Transactions; fx:user_accesses: UserAccesses; fx:users: Users; self: Backend.Rels.Store }

Type declaration

  • fx:attributes: Backend.Rels.Attributes

    List of custom attributes of this store.

  • fx:cart_include_templates: CartIncludeTemplates

    List of cart include templates available in this store.

  • fx:cart_templates: CartTemplates

    List of cart templates available in this store.

  • fx:carts: Carts

    List of carts in this store.

  • fx:checkout_templates: CheckoutTemplates

    List of checkout templates for this store.

  • fx:coupons: Coupons

    List of coupons available in this store.

  • fx:customer_portal_settings: Backend.Rels.CustomerPortalSettings

    Configuration of this store's customer portal.

  • fx:customers: Customers

    List of customers of this store.

  • fx:downloadables: Downloadables

    List of downloadable products available in this store.

  • fx:email_templates: EmailTemplates

    List of email templates for this store.

  • fx:error_entries: ErrorEntries

    List of error entries for this store.

  • fx:fraud_protections: FraudProtections

    List of fraud protection measures enabled on this store.

  • fx:gift_cards: GiftCards

    List of gift cards available in this store.

  • fx:hosted_payment_gateways: HostedPaymentGateways

    List of hosted payment gateways enabled for this store.

  • fx:item_categories: ItemCategories

    List of item categories configured in this store.

  • fx:payment_method_sets: PaymentMethodSets

    List of payment method sets configured for this store.

  • fx:process_subscription_webhook: ProcessSubscriptionWebhook

    POST here to resend the daily subscription webhook notification for this store.

  • fx:receipt_templates: ReceiptTemplates

    List of receipt templates for this store.

  • fx:reports: Reports

    List of reports for this store.

  • fx:store_shipping_methods: StoreShippingMethods

    List of shipping methods supported by this store.

  • fx:store_version: StoreVersion

    Version of this store.

  • fx:subscription_settings: SubscriptionSettings

    Subscription settings for this store.

  • fx:subscriptions: Backend.Rels.Subscriptions

    List of subscriptions created in this store.

  • fx:taxes: Taxes

    List of taxes configured for this store.

  • fx:template_sets: TemplateSets

    List of template sets configured for this store.

  • fx:transactions: Backend.Rels.Transactions

    List of transactions performed in this store.

  • fx:user_accesses: UserAccesses

    List of user access resources for this store.

  • fx:users: Users

    List of users with access to this store.

  • self: Backend.Rels.Store

    This resource.

props: { affiliate_id: number; app_session_time: number; bcc_on_receipt_email: boolean; checkout_type: string; country: string; custom_display_id_config: string; customer_password_hash_config: unknown; customer_password_hash_type: string; date_created: null | string; date_modified: null | string; features_multiship: boolean; first_payment_date: string; from_email: string; hide_currency_symbol: boolean; hide_decimal_characters: boolean; is_active: boolean; is_maintenance_mode: boolean; language: string; locale_code: string; logo_url: string; postal_code: string; products_require_expires_property: boolean; receipt_continue_url: string; region: string; require_signed_shipping_rates: boolean; shipping_address_type: string; single_sign_on_url: string; smtp_config: string; store_domain: string; store_email: string; store_name: string; store_url: string; store_version_uri: string; timezone: string; unified_order_entry_password: string; use_cart_validation: boolean; use_email_dns: boolean; use_international_currency_symbol: boolean; use_remote_domain: boolean; use_single_sign_on: boolean; use_webhook: boolean; webhook_key: string; webhook_url: string }

Type declaration

  • affiliate_id: number

    This can only be set during store creation. Contact us if you need this value changed later.

  • app_session_time: number

    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).

  • bcc_on_receipt_email: boolean

    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.

  • checkout_type: string

    The preferred configuration of your customer checkout experience, such as defaulting to guest checkout or requiring account creation with each checkout.

  • country: string

    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.

  • custom_display_id_config: string

    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.

  • customer_password_hash_config: unknown

    Configuration settings for the customer_password_hash_type in use. See the FoxyCart documentation for more details.

  • customer_password_hash_type: string

    When saving a customer to FoxyCart, this is the password hashing method that will be used.

  • date_created: null | string

    The date this resource was created.

  • date_modified: null | string

    The date this resource was last modified.

  • features_multiship: boolean

    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.

  • first_payment_date: string

    The date of the first payment for this FoxyCart store subscription. This can be considered the go live date for this store.

  • from_email: string

    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.

  • hide_currency_symbol: boolean

    Set to true to prevent the currency symbol from being displayed (example: a points based checkout system).

  • hide_decimal_characters: boolean

    Set to true to prevent the decimal characters from being displayed (example: a points based checkout system).

  • is_active: boolean

    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.

  • is_maintenance_mode: boolean

    This settings makes your checkout page completely non-functioning. Your customers will see the maintenance notification language string instead. The default is false.

  • language: string

    The default language for your store's cart, checkout, and receipt strings.

  • locale_code: string

    The locale code for your store's locale. This will be used to format strings for your store.

  • logo_url: string

    A url to your store's logo which may be used in your store's templates.

  • postal_code: string

    The postal code of your store. This will be used for calculating shipping costs if you sell shippable items.

  • products_require_expires_property: boolean

    Set to true to require all front-end add-to-cart interactions have a valid expires property.

  • receipt_continue_url: string

    By default, FoxyCart sends customers back to the page referrer after completing a purchase. Instead, you can set a specific URL here.

  • region: string

    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.

  • require_signed_shipping_rates: boolean

    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.

  • shipping_address_type: string

    Used for determining the type of the customer address used when calculating shipping costs.

  • single_sign_on_url: string

    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.

  • smtp_config: string

    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

  • store_domain: string

    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.

  • store_email: string

    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.

  • store_name: string

    The name of your store as you'd like it displayed to your customers and our system.

  • store_url: string

    The URL of your online store.

  • store_version_uri: string

    This is the store version for this store. For more details about this version, see the store_versions property helpers which include changelog information.

  • timezone: string

    The timezone of your store. This will impact how dates are shown to customers and within the FoxyCart admin.

  • unified_order_entry_password: string

    Set a master password here if you would like to be able to check out as your customers without having to know their password.

  • use_cart_validation: boolean

    Set to true to use HMAC cart validation for your store.

  • use_email_dns: boolean

    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.

  • use_international_currency_symbol: boolean

    Set true to use the international currency symbol such as USD instead of the regional one like $.

  • use_remote_domain: boolean

    Set to true when you plan to use a custom SSL certificate. If set to true, your store_domain must be a full domain.

  • use_single_sign_on: boolean

    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.

  • use_webhook: boolean

    Set this to true to POST encrypted XML of your order to the webhook url of your choice.

  • webhook_key: string

    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.

  • webhook_url: string

    This is the url of the webhook endpoint for processing your store's webhook. See the FoxyCart documentation for more details.

zooms?: Readonly<Record<string, undefined | Core.Graph>>

Generated using TypeDoc