store : Foxy hAPI

stores

Description

This link relationship returns a collection of resources. You can easily paginate through this collection using the hypermedia links provided and the link relationships of first, prev, next, and last. Scroll down to view a representation of a single resource embedded within this collection.

When creating a store resource, the response will include the OAuth Access and Refresh tokens required to work with this resource via the API. It's important to save this information in your database. If you lose it, you'll have to do an OAuth Authorization Code grant via your browser.

This page has an example of how to create a store using cURL.

Interact with this resource

To interact with this resource and see it in the context of the API, you can utilise Postman or your Terminal/Console to perform requests. If you have a Foxy store, you can also use the API browser in the admin to interact with resources connected to your store.

Actions

GET: View a list of stores
POST: Create a new store
HEAD: Get just the header response
OPTIONS: Get a response explaining which HTTP methods are supported

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "...",
      "title": "This Collection"
    },
    "first": {
      "href": "...?offset=0",
      "title": "First Page of this Collection"
    },
    "prev": {
      "href": "...?offset=0",
      "title": "Previous Page of this Collection"
    },
    "next": {
      "href": "...?offset=0",
      "title": "Next Page of this Collection"
    },
    "last": {
      "href": "...?offset=0",
      "title": "Last Page of this Collection"
    }
  },
  "_embedded": {
    "fx:stores": [...]
  },
  "total_items": "5",
  "returned_items": 5,
  "limit": 20,
  "offset": 0
}


Response from POST:

{
  "_links": {
    "curies": [
        {
            "name": "fx",
            "href": "https://api.foxycart.com/rels/{rel}",
            "templated": true
        }
    ],
    "self": {
      "href": "https://api.foxycart.com/stores/9072",
      "title": "This Store"
    },
    "fx:attributes": {
      "href": "https://api.foxycart.com/stores/9072/attributes",
      "title": "Attributes for This Store"
    },
    "fx:store_version": {
      "href": "https://api.foxycart.com/property_helpers/store_versions/21",
      "title": "This store version"
    },
    "fx:users": {
      "href": "https://api.foxycart.com/stores/9072/users",
      "title": "Users for This Store"
    },
    "fx:user_accesses": {
      "href": "https://api.foxycart.com/stores/9072/user_accesses",
      "title": "User Access for This Store"
    },
    "fx:customers": {
      "href": "https://api.foxycart.com/stores/9072/customers",
      "title": "Customers for This Store"
    },
    "fx:carts": {
      "href": "https://api.foxycart.com/stores/9072/carts",
      "title": "Carts for This Store"
    },
    "fx:transactions": {
      "href": "https://api.foxycart.com/stores/9072/transactions",
      "title": "Transactions for This Store"
    },
    "fx:subscriptions": {
      "href": "https://api.foxycart.com/stores/9072/subscriptions",
      "title": "Subscriptions for This Store"
    },
    "fx:subscription_settings": {
      "href": "https://api.foxycart.com/store_subscription_settings/9072",
      "title": "Subscription Settings for This Store"
    },
    "fx:item_categories": {
      "href": "https://api.foxycart.com/stores/9072/item_categories",
      "title": "Item Categories for This Store"
    },
    "fx:taxes": {
      "href": "https://api.foxycart.com/stores/9072/taxes",
      "title": "Taxes for This Store"
    },
    "fx:payment_method_sets": {
      "href": "https://api.foxycart.com/stores/9072/payment_method_sets",
      "title": "Payment Method Sets for This Store"
    },
    "fx:coupons": {
      "href": "https://api.foxycart.com/stores/9072/coupons",
      "title": "Coupons for This Store"
    },
    "fx:template_sets": {
      "href": "https://api.foxycart.com/stores/9072/template_sets",
      "title": "Template Sets for This Store"
    },
    "fx:cart_templates": {
      "href": "https://api.foxycart.com/stores/9072/cart_templates",
      "title": "Cart Templates for This Store"
    },
    "fx:cart_include_templates": {
      "href": "https://api.foxycart.com/stores/9072/cart_include_templates",
      "title": "Cart Include Templates for This Store"
    },
    "fx:checkout_templates": {
      "href": "https://api.foxycart.com/stores/9072/checkout_templates",
      "title": "Checkout Templates for This Store"
    },
    "fx:receipt_templates": {
      "href": "https://api.foxycart.com/stores/9072/receipt_templates",
      "title": "Receipt Templates for This Store"
    },
    "fx:email_templates": {
      "href": "https://api.foxycart.com/stores/9072/email_templates",
      "title": "Email Templates for This Store"
    },
    "fx:error_entries": {
      "href": "https://api.foxycart.com/stores/9072/error_entries",
      "title": "Error Entries for This Store"
    },
    "fx:downloadables": {
      "href": "https://api.foxycart.com/stores/9072/downloadables",
      "title": "Downloadables for This Store"
    },
    "fx:hosted_payment_gateways": {
      "href": "https://api.foxycart.com/stores/9072/hosted_payment_gateways",
      "title": "Hosted Payment Gateways for This Store"
    },
    "fx:fraud_protections": {
      "href": "https://api.foxycart.com/stores/9072/fraud_protections",
      "title": "Fraud Protections for This Store"
    }
  },
  "message": "store 9072 created successfully.",
  "token": {
    "access_token": "979a9fe612a2a463f068f722e9a6cb0b212b5870",
    "expires_in": 7200,
    "token_type": "bearer",
    "scope": "store_id_9072 store_full_access",
    "refresh_token": "4738dcf19bebdef70759021c33f385db9acb24e1"
  }
}

<?xml version="1.0" encoding="UTF-8"?>
<resource href="...">
  <link rel="self" href="..." title="This Collection"/>
  <link rel="first" href="...?offset=0" title="First Page of this Collection"/>
  <link rel="prev" href="...?offset=0" title="Previous Page of this Collection"/>
  <link rel="next" href="...?offset=0" title="Next Page of this Collection"/>
  <link rel="last" href="...?offset=0" title="Last Page of this Collection"/>
  <resource href="..." rel="https://api.foxycart.com/rels/store">
  ...
  </resource>
  <total_items>5</total_items>
  <returned_items>5</returned_items>
  <limit>20</limit>
  <offset>0</offset>
</resource>


Response from POST:

<?xml version="1.0" encoding="UTF-8"?>
<resource href="https://api.foxycart.com/stores/9072">
  <link rel="self" href="https://api.foxycart.com/stores/9072" title="This Store"/>
  <link rel="https://api.foxycart.com/rels/attributes" href="https://api.foxycart.com/stores/9072/attributes" title="Attributes for This Store"/>
  <link rel="https://api.foxycart.com/rels/store_version" href="https://api.foxycart.com/property_helpers/store_versions/100" title="This store version"/>
  <link rel="https://api.foxycart.com/rels/users" href="https://api.foxycart.com/stores/9072/users" title="Users for This Store"/>
  <link rel="https://api.foxycart.com/rels/user_accesses" href="https://api.foxycart.com/stores/9072/user_accesses" title="User Access for This Store"/>
  <link rel="https://api.foxycart.com/rels/customers" href="https://api.foxycart.com/stores/9072/customers" title="Customers for This Store"/>
  <link rel="https://api.foxycart.com/rels/carts" href="https://api.foxycart.com/stores/9072/carts" title="Carts for This Store"/>
  <link rel="https://api.foxycart.com/rels/transactions" href="https://api.foxycart.com/stores/9072/transactions" title="Transactions for This Store"/>
  <link rel="https://api.foxycart.com/rels/subscriptions" href="https://api.foxycart.com/stores/9072/subscriptions" title="Subscriptions for This Store"/>
  <link rel="https://api.foxycart.com/rels/subscription_settings" href="https://api.foxycart.com/store_subscription_settings/9072" title="Subscription Settings for This Store"/>
  <link rel="https://api.foxycart.com/rels/item_categories" href="https://api.foxycart.com/stores/9072/item_categories" title="Item Categories for This Store"/>
  <link rel="https://api.foxycart.com/rels/taxes" href="https://api.foxycart.com/stores/9072/taxes" title="Taxes for This Store"/>
  <link rel="https://api.foxycart.com/rels/payment_method_sets" href="https://api.foxycart.com/stores/9072/payment_method_sets" title="Payment Method Sets for This Store"/>
  <link rel="https://api.foxycart.com/rels/coupons" href="https://api.foxycart.com/stores/9072/coupons" title="Coupons for This Store"/>
  <link rel="https://api.foxycart.com/rels/template_sets" href="https://api.foxycart.com/stores/9072/template_sets" title="Template Sets for This Store"/>
  <link rel="https://api.foxycart.com/rels/cart_templates" href="https://api.foxycart.com/stores/9072/cart_templates" title="Cart Templates for This Store"/>
  <link rel="https://api.foxycart.com/rels/cart_include_templates" href="https://api.foxycart.com/stores/9072/cart_include_templates" title="Cart Include Templates for This Store"/>
  <link rel="https://api.foxycart.com/rels/checkout_templates" href="https://api.foxycart.com/stores/9072/checkout_templates" title="Checkout Templates for This Store"/>
  <link rel="https://api.foxycart.com/rels/receipt_templates" href="https://api.foxycart.com/stores/9072/receipt_templates" title="Receipt Templates for This Store"/>
  <link rel="https://api.foxycart.com/rels/email_templates" href="https://api.foxycart.com/stores/9072/email_templates" title="Email Templates for This Store"/>
  <link rel="https://api.foxycart.com/rels/error_entries" href="https://api.foxycart.com/stores/9072/error_entries" title="Error Entries for This Store"/>
  <link rel="https://api.foxycart.com/rels/downloadables" href="https://api.foxycart.com/stores/9072/downloadables" title="Downloadables for This Store"/>
  <link rel="https://api.foxycart.com/rels/hosted_payment_gateways" href="https://api.foxycart.com/stores/9072/hosted_payment_gateways" title="Hosted Payment Gateways for This Store"/>
  <link rel="https://api.foxycart.com/rels/fraud_protections" href="https://api.foxycart.com/stores/9072/fraud_protections" title="Fraud Protections for This Store"/>
  <message>store 9072 created successfully.</message>
  <token>
    <access_token>979a9fe612a2a463f068f722e9a6cb0b212b5870</access_token>
    <expires_in>7200</expires_in>
    <token_type>bearer</token_type>
    <scope>store_id_9072 store_full_access</scope>
    <refresh_token>4738dcf19bebdef70759021c33f385db9acb24e1</refresh_token>
  </token>
</resource>

{
    "properties": {
        "total_items": "5",
        "returned_items": 5,
        "limit": 20,
        "offset": 0
    },
    "entities": [...],
    "links": [
        {
            "rel": [
                "self"
            ],
            "href": "..."
        },
        {
            "rel": [
                "first"
            ],
            "href": "...?offset=0"
        },
        {
            "rel": [
                "prev"
            ],
            "href": "...?offset=0"
        },
        {
            "rel": [
                "next"
            ],
            "href": "...?offset=0"
        },
        {
            "rel": [
                "last"
            ],
            "href": "...?offset=0"
        }
    ],
    "actions": [
    ]
}


Response from POST:
{
    "properties": {
        "message": "store 9072 created successfully.",
        "token": {
            "access_token": "590a79faf06e4062cabf2ec89072a6c121065417fc",
            "expires_in": 7200,
            "token_type": "bearer",
            "scope": "store_id_9072 store_full_access",
            "refresh_token": "3ea1c2d62826cddce440ceaa0d69c9b396ee394a"
        }
    },
    "links": [
        {
            "rel": [
                "self"
            ],
            "href": "https://api.foxycart.com/stores/9072"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/attributes"
            ],
            "href": "https://api.foxycart.com/stores/9072/attributes"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/store_version"
            ],
            "href": "https://api.foxycart.com/property_helpers/store_versions/100"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/users"
            ],
            "href": "https://api.foxycart.com/stores/9072/users"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/user_accesses"
            ],
            "href": "https://api.foxycart.com/stores/9072/user_accesses"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/customers"
            ],
            "href": "https://api.foxycart.com/stores/9072/customers"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/carts"
            ],
            "href": "https://api.foxycart.com/stores/9072/carts"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/transactions"
            ],
            "href": "https://api.foxycart.com/stores/9072/transactions"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/subscriptions"
            ],
            "href": "https://api.foxycart.com/stores/9072/subscriptions"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/subscription_settings"
            ],
            "href": "https://api.foxycart.com/store_subscription_settings/9072"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/item_categories"
            ],
            "href": "https://api.foxycart.com/stores/9072/item_categories"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/taxes"
            ],
            "href": "https://api.foxycart.com/stores/9072/taxes"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/payment_method_sets"
            ],
            "href": "https://api.foxycart.com/stores/9072/payment_method_sets"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/coupons"
            ],
            "href": "https://api.foxycart.com/stores/9072/coupons"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/template_sets"
            ],
            "href": "https://api.foxycart.com/stores/9072/template_sets"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/cart_templates"
            ],
            "href": "https://api.foxycart.com/stores/9072/cart_templates"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/cart_include_templates"
            ],
            "href": "https://api.foxycart.com/stores/9072/cart_include_templates"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/checkout_templates"
            ],
            "href": "https://api.foxycart.com/stores/9072/checkout_templates"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/receipt_templates"
            ],
            "href": "https://api.foxycart.com/stores/9072/receipt_templates"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/email_templates"
            ],
            "href": "https://api.foxycart.com/stores/9072/email_templates"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/error_entries"
            ],
            "href": "https://api.foxycart.com/stores/9072/error_entries"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/downloadables"
            ],
            "href": "https://api.foxycart.com/stores/9072/downloadables"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/hosted_payment_gateways"
            ],
            "href": "https://api.foxycart.com/stores/9072/hosted_payment_gateways"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/fraud_protections"
            ],
            "href": "https://api.foxycart.com/stores/9072/fraud_protections"
        }
    ]
}

Embedded Resource: store

Description

A FoxyCart Store is your home for managing your online payment system as it relates to FoxyCart's platform. One store will be used per organization selling online. You can create a store for free and use it as long as you like until you read ready to collect live payments from your customers. We also recommend setting up a development store along with your production store so you can test out new features. Before you create a store, you must create a client and a user. When creating a store, you'll get a response back containing an OAuth token giving you access to the store.

As part of security protections against abuse, an hCaptcha header is required as part of store creation. It is passed through a h-captcha-code header with the POST request to create a store. If you have a need to create stores as part of a platform integration, please get in touch with our support team to discuss this requirement further.

If you create custom attributes for your store, they will automatically be included in the response as embedded resources without having to zoom in on them.

The smtp_config value should be a JSON string which includes the following values:

username: Your SMTP server username
password: Your SMTP server password
host: Your SMTP server host
port: Your SMTP server port
security: If your server requires a secure connection, you can use ssl or tls here.

The custom_display_id_config value should be a JSON string which includes the following values:

enabled: A boolean, true or false.
start: The starting value for your custom order id display such as 1.
length: The minimum total length of the auto-incrementing part of the display ID.
prefix: The prefix you'd like your custom display id to being with.
suffix: The suffix you'd like your custom display id to end with.

Inside custom_display_id_config you can also include transaction_journal_entries node with the following values:

enabled: A boolean, true or false.
transaction_separator: Separator between transaction id and transaction action. String - length 10
log_detail_request_types: JSON object, includes prefixes for every transaction action. Currently only allowed transaction actions are: transaction_authcapture, transaction_refund, transaction_capture, transaction_void

transaction_authcapture:

prefix: prefix for the transaction action - string

transaction_refund:

prefix: prefix for the transaction action - string

transaction_capture:

prefix: prefix for the transaction action - string

transaction_void:

prefix: prefix for the transaction action - string

The features value should be a JSON string which includes the following values:

allow_transaction_editing: Allows merchants to capture/void/refund transactions. Also allows merchants to edit completed transactions. A boolean, true or false.

Interact with this resource

Actions

GET: View a store
PATCH: Update a store (send only the properties you want to modify)
PUT: Replace a store (send the entire representation)
DELETE: Delete a store
HEAD: Get just the header response
OPTIONS: Get a response explaining which HTTP methods are supported

Properties

Property	Description	Type	Constraints
store_version_uri	This is the store version for this store. For more details about this version, see the store_versions property helpers which include changelog information.	URL	Defaults to the latest version if not provided. store_versions
store_name	The name of your store as you'd like it displayed to your customers and our system.	String	Required. 100 characters or less.
store_domain	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.	String	Required. 50 characters or less.
use_remote_domain	Set to true when you plan to use a custom SSL certificate. If set to true, your store_domain must be a full domain.	Boolean	true or false, 1 or 0.
store_url	The URL of your online store.	URL	Required. 300 characters or less.
receipt_continue_url	By default, FoxyCart sends customers back to the page referrer after completing a purchase. Instead, you can set a specific URL here.	URL	300 characters or less.
store_email	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.	Email	Required. 300 characters or less.
from_email	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.	Email	100 characters or less.
bcc_on_receipt_email	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.	Boolean	true or false, 1 or 0.
use_email_dns	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.	Boolean	true or false, 1 or 0.
send_html_email	Set this to true if you want to send text and HTML email receipts and false if you send text emails only. This setting only impacts the main transaction receipt emails for the store.	Boolean	true or false, 1 or 0.
smtp_config	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`	JSON	1000 characters or less.
postal_code	The postal code of your store. This will be used for calculating shipping costs if you sell shippable items.	String	Required. 50 characters or less.
region	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.	String	Required. 2 characters if code exists, otherwise 100 characters or less. regions
country	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.	String	Required. countries
locale_code	The locale code for your Store's locale. This will be used to format strings for your store.	String	Defaults to en_US if not supplied. locale_codes
hide_currency_symbol	Set to true to prevent the currency symbol from being displayed (example: a points based checkout system).	Boolean	true or false, 1 or 0.
hide_decimal_characters	Set to true to prevent the decimal characters from being displayed (example: a points based checkout system).	Boolean	true or false, 1 or 0.
use_international_currency_symbol	Set true to use the international currency symbol such as USD instead of the regional one like $.	Boolean	true or false, 1 or 0.
language	The default language for your store's cart, checkout, and receipt strings.	String	Defaults to english if not supplied. languages
logo_url	A url to your store's logo which may be used in your store's templates.	URL	200 characters or less.
checkout_type	The preferred configuration of your customer checkout experience, such as defaulting to guest checkout or requiring account creation with each checkout.	String	Defaults to default_account checkout_types
use_webhook	Set this to true to POST encrypted XML of your order to the webhook url of your choice.	Boolean	true or false, 1 or 0.
webhook_url	This is the url of the webhook endpoint for processing your store's webhook. See the FoxyCart documentation for more details.	URL	Required if use_webhook is true. 300 characters or less.
webhook_key	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.	String	Required if use_webhook or use_cart_validation is true. 200 characters or less.
use_cart_validation	Set to true to use HMAC cart validation for your store.	Boolean	true or false, 1 or 0.
use_single_sign_on	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.	Boolean	true or false, 1 or 0.
single_sign_on_url	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.	URL	Required if use_single_sign_on is true. 300 characters or less.
customer_password_hash_type	When saving a customer to FoxyCart, this is the password hashing method that will be used.	String	Defaults to phpass. customer_password_hash_types
customer_password_hash_config	Configuration settings for the customer_password_hash_type in use. See the FoxyCart documentation for more details.	String	100 characters or less.
features_multiship	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.	Boolean	true or false, 1 or 0.
products_require_expires_property	Set to true to require all front-end add-to-cart interactions have a valid `expires` property.	Boolean	true or false, 1 or 0.
app_session_time	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 1209600 seconds (14 days).	Integer	Time in seconds.
shipping_address_type	Used for determining the type of the customer address used when calculating shipping costs.	String	Defaults to determine_by_company. shipping_address_types
require_signed_shipping_rates	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.	Boolean	true or false, 1 or 0.
timezone	The timezone of your store. This will impact how dates are shown to customers and within the FoxyCart admin.	String	Defaults to server time America/Los Angeles. timezones
unified_order_entry_password	Set a master password here if you would like to be able to check out as your customers without having to know their password.	String	100 characters or less.
custom_display_id_config	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` There is an optional node `transaction_journal_entries` with the following fields: `enabled`, `transaction_separator`, `log_detail_request_types`.	JSON	500 characters or less.
affiliate_id	This can only be set during store creation. Contact us if you need this value changed later.	Integer	Can only be set on creation.
is_maintenance_mode	This settings makes your checkout page completely non-functioning. Your customers will see the maintenance notification language string instead. The default is false.	Boolean	true or false, 1 or 0.
is_active	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.	Boolean	Read only
first_payment_date	The date of the first payment for this FoxyCart store subscription. This can be considered the go live date for this store.	Date	Read only
features	This JSON config determines which features are turned on for the store. Currently the following features are supported: `allow_transaction_editing`. Values for the fields are `true` or `false`	JSON	500 characters or less.
date_created	The date this resource was created.	Date	Read only
date_modified	The date this resource was last modified.	Date	Read only

Example Representation

{
  "_links": {
    "curies": [
        {
            "name": "fx",
            "href": "https://api.foxycart.com/rels/{rel}",
            "templated": true
        }
    ],
    "self": {
      "href": "https://api.foxycart.com/stores/2",
      "title": "This Store"
    },
    "fx:attributes": {
      "href": "https://api.foxycart.com/stores/2/attributes",
      "title": "Attributes for This Store"
    },
    "fx:store_version": {
      "href": "https://api.foxycart.com/property_helpers/store_versions/100",
      "title": "This store version"
    },
    "fx:users": {
      "href": "https://api.foxycart.com/stores/2/users",
      "title": "Users for This Store"
    },
    "fx:user_accesses": {
      "href": "https://api.foxycart.com/stores/2/user_accesses",
      "title": "User Access for This Store"
    },
    "fx:customers": {
      "href": "https://api.foxycart.com/stores/2/customers",
      "title": "Customers for This Store"
    },
    "fx:carts": {
      "href": "https://api.foxycart.com/stores/2/carts",
      "title": "Carts for This Store"
    },
    "fx:transactions": {
      "href": "https://api.foxycart.com/stores/2/transactions",
      "title": "Transactions for This Store"
    },
    "fx:subscriptions": {
      "href": "https://api.foxycart.com/stores/2/subscriptions",
      "title": "Subscriptions for This Store"
    },
    "fx:subscription_settings": {
      "href": "https://api.foxycart.com/store_subscription_settings/2",
      "title": "Subscription Settings for This Store"
    },
    "fx:customer_portal_settings": {
        "href": "https://api.foxycart.com/stores/2/customer_portal_settings",
        "title": "Customer Portal Settings for This Store"
    },
    "fx:process_subscription_webhook": {
        "href": "https://api.foxycart.com/stores/2/process_subscription_webhook",
        "title": "POST here to resend the daily subscription webhook notification for this store"
    },
    "fx:item_categories": {
      "href": "https://api.foxycart.com/stores/2/item_categories",
      "title": "Item Categories for This Store"
    },
    "fx:taxes": {
      "href": "https://api.foxycart.com/stores/2/taxes",
      "title": "Taxes for This Store"
    },
    "fx:payment_method_sets": {
      "href": "https://api.foxycart.com/stores/2/payment_method_sets",
      "title": "Payment Method Sets for This Store"
    },
    "fx:coupons": {
      "href": "https://api.foxycart.com/stores/2/coupons",
      "title": "Coupons for This Store"
    },
    "fx:template_sets": {
      "href": "https://api.foxycart.com/stores/2/template_sets",
      "title": "Template Sets for This Store"
    },
    "fx:cart_templates": {
      "href": "https://api.foxycart.com/stores/2/cart_templates",
      "title": "Cart Templates for This Store"
    },
    "fx:cart_include_templates": {
      "href": "https://api.foxycart.com/stores/2/cart_include_templates",
      "title": "Cart Include Templates for This Store"
    },
    "fx:checkout_templates": {
      "href": "https://api.foxycart.com/stores/2/checkout_templates",
      "title": "Checkout Templates for This Store"
    },
    "fx:receipt_templates": {
      "href": "https://api.foxycart.com/stores/2/receipt_templates",
      "title": "Receipt Templates for This Store"
    },
    "fx:email_templates": {
      "href": "https://api.foxycart.com/stores/2/email_templates",
      "title": "Email Templates for This Store"
    },
    "fx:error_entries": {
      "href": "https://api.foxycart.com/stores/2/error_entries",
      "title": "Error Entries for This Store"
    },
    "fx:downloadables": {
      "href": "https://api.foxycart.com/stores/2/downloadables",
      "title": "Downloadables for This Store"
    },
    "fx:hosted_payment_gateways": {
      "href": "https://api.foxycart.com/stores/2/hosted_payment_gateways",
      "title": "Hosted Payment Gateways for This Store"
    },
    "fx:fraud_protections": {
      "href": "https://api.foxycart.com/stores/2/fraud_protections",
      "title": "Fraud Protections for This Store"
    }
  },
  "store_version_uri": "https://api.foxycart.com/property_helpers/store_versions/20",
  "store_name": "Example Store",
  "store_domain": "example",
  "use_remote_domain": false,
  "store_url": "https://example.com/catalog",
  "receipt_continue_url": "http://www.example.com/thankyou",
  "store_email": "someone@example.com",
  "from_email": "helpdesk@example.com",
  "bcc_on_receipt_email": false,
  "smtp_config": "{\"username\":\"someone@gmail.com\",\"password\":\"mycomplexpassword\",\"host\":\"smtp.gmail.com\",\"port\":\"465\",\"security\":\"ssl\"}",
  "use_email_dns": false,
  "postal_code": "37211",
  "region": "TN",
  "country": "US",
  "locale_code": "en_US",
  "hide_currency_symbol": false,
  "hide_decimal_characters": false,
  "use_international_currency_symbol": false,
  "language": "english",
  "logo_url": "",
  "checkout_type": "default_account",
  "use_webhook": true,
  "webhook_url": "http://example.com/my_webhook_script",
  "webhook_key": "some super secure password your mom could not not guess",
  "use_cart_validation": false,
  "use_single_sign_on": false,
  "single_sign_on_url": "http://example.com/my_single_sign_on_script",
  "customer_password_hash_type": "phpass",
  "customer_password_hash_config": "8",
  "features_multiship": false,
  "products_require_expires_property": false,
  "app_session_time": 43200,
  "shipping_address_type": "residential",
  "require_signed_shipping_rates": false,
  "timezone": "America/Chicago",
  "unified_order_entry_password": "here I am, buying all your stufz",
  "custom_display_id_config": {
        "enabled": true,
        "start": "1",
        "length": "",
        "prefix": "TI-",
        "suffix": "",
        "transaction_journal_entries": {
            "transaction_separator": "-",
            "enabled": true,
            "log_detail_request_types": {
                "transaction_authcapture": {
                    "prefix": "AC-"
                },
                "transaction_refund": {
                    "prefix": "RF-"
                },
                "transaction_capture": {
                    "prefix": "CP-"
                },
                "transaction_void": {
                    "prefix": "VO-"
                }
            }
        }
    },
  "affiliate_id": 0,
  "is_maintenance_mode": false,
  "is_active": false,
  "first_payment_date": null,
  "features": {
    "allow_transaction_editing": true
  }
  "date_created": "2010-04-24T19:25:02-0700",
  "date_modified": "2013-07-19T11:47:26-0700"
}

<?xml version="1.0" encoding="UTF-8"?>
<resource href="https://api.foxycart.com/stores/2" rel="https://api.foxycart.com/rels/store">
  <link rel="self" href="https://api.foxycart.com/stores/2" title="This Store"/>
  <link rel="https://api.foxycart.com/rels/attributes" href="https://api.foxycart.com/stores/2/attributes" title="Attributes for This Store"/>
  <link rel="https://api.foxycart.com/rels/store_version" href="https://api.foxycart.com/property_helpers/store_versions/100" title="This store version"/>
  <link rel="https://api.foxycart.com/rels/users" href="https://api.foxycart.com/stores/2/users" title="Users for This Store"/>
  <link rel="https://api.foxycart.com/rels/user_accesses" href="https://api.foxycart.com/stores/2/user_accesses" title="User Access for This Store"/>
  <link rel="https://api.foxycart.com/rels/customers" href="https://api.foxycart.com/stores/2/customers" title="Customers for This Store"/>
  <link rel="https://api.foxycart.com/rels/carts" href="https://api.foxycart.com/stores/2/carts" title="Carts for This Store"/>
  <link rel="https://api.foxycart.com/rels/transactions" href="https://api.foxycart.com/stores/2/transactions" title="Transactions for This Store"/>
  <link rel="https://api.foxycart.com/rels/subscriptions" href="https://api.foxycart.com/stores/2/subscriptions" title="Subscriptions for This Store"/>
  <link rel="https://api.foxycart.com/rels/subscription_settings" href="https://api.foxycart.com/store_subscription_settings/2" title="Subscription Settings for This Store"/>
  <link rel="https://api.foxycart.com/rels/item_categories" href="https://api.foxycart.com/stores/2/item_categories" title="Item Categories for This Store"/>
  <link rel="https://api.foxycart.com/rels/taxes" href="https://api.foxycart.com/stores/2/taxes" title="Taxes for This Store"/>
  <link rel="https://api.foxycart.com/rels/payment_method_sets" href="https://api.foxycart.com/stores/2/payment_method_sets" title="Payment Method Sets for This Store"/>
  <link rel="https://api.foxycart.com/rels/coupons" href="https://api.foxycart.com/stores/2/coupons" title="Coupons for This Store"/>
  <link rel="https://api.foxycart.com/rels/template_sets" href="https://api.foxycart.com/stores/2/template_sets" title="Template Sets for This Store"/>
  <link rel="https://api.foxycart.com/rels/cart_templates" href="https://api.foxycart.com/stores/2/cart_templates" title="Cart Templates for This Store"/>
  <link rel="https://api.foxycart.com/rels/cart_include_templates" href="https://api.foxycart.com/stores/2/cart_include_templates" title="Cart Include Templates for This Store"/>
  <link rel="https://api.foxycart.com/rels/checkout_templates" href="https://api.foxycart.com/stores/2/checkout_templates" title="Checkout Templates for This Store"/>
  <link rel="https://api.foxycart.com/rels/receipt_templates" href="https://api.foxycart.com/stores/2/receipt_templates" title="Receipt Templates for This Store"/>
  <link rel="https://api.foxycart.com/rels/email_templates" href="https://api.foxycart.com/stores/2/email_templates" title="Email Templates for This Store"/>
  <link rel="https://api.foxycart.com/rels/error_entries" href="https://api.foxycart.com/stores/2/error_entries" title="Error Entries for This Store"/>
  <link rel="https://api.foxycart.com/rels/downloadables" href="https://api.foxycart.com/stores/2/downloadables" title="Downloadables for This Store"/>
  <link rel="https://api.foxycart.com/rels/hosted_payment_gateways" href="https://api.foxycart.com/stores/2/hosted_payment_gateways" title="Hosted Payment Gateways for This Store"/>
  <link rel="https://api.foxycart.com/rels/fraud_protections" href="https://api.foxycart.com/stores/2/fraud_protections" title="Fraud Protections for This Store"/>
  <store_version_uri>https://api.foxycart.com/property_helpers/store_versions/20</store_version_uri>
  <store_name>Example Store</store_name>
  <store_domain>example</store_domain>
  <use_remote_domain>false</use_remote_domain>
  <store_url>https://example.com/catalog</store_url>
  <receipt_continue_url>http://www.example.com/thankyou</receipt_continue_url>
  <store_email>someone@example.com</store_email>
  <from_email>helpdesk@example.com</from_email>
  <bcc_on_receipt_email>false</bcc_on_receipt_email>
  <smtp_config>{"username":"someone@gmail.com","password":"mycomplexpassword","host":"smtp.gmail.com","port":"465","security":"ssl"}</smtp_config>
  <use_email_dns>false</use_email_dns>
  <postal_code>37211</postal_code>
  <region>TN</region>
  <country>US</country>
  <locale_code>en_US</locale_code>
  <hide_currency_symbol>false</hide_currency_symbol>
  <hide_decimal_characters>false</hide_decimal_characters>
  <use_international_currency_symbol>false</use_international_currency_symbol>
  <language>english</language>
  <logo_url></logo_url>
  <checkout_type>default_account</checkout_type>
  <use_webhook>true</use_webhook>
  <webhook_url>http://example.com/my_webhook_script</webhook_url>
  <webhook_key>some super secure password your mom could not not guess</webhook_key>
  <use_cart_validation>false</use_cart_validation>
  <use_single_sign_on>false</use_single_sign_on>
  <single_sign_on_url>http://example.com/my_single_sign_on_script</single_sign_on_url>
  <customer_password_hash_type>phpass</customer_password_hash_type>
  <customer_password_hash_config>8</customer_password_hash_config>
  <features_multiship>false</features_multiship>
  <products_require_expires_property>false</products_require_expires_property>
  <app_session_time>43200</app_session_time>
  <shipping_address_type>residential</shipping_address_type>
  <require_signed_shipping_rates>false</require_signed_shipping_rates>
  <timezone>America/Chicago</timezone>
  <unified_order_entry_password>here I am, buying all your stufz</unified_order_entry_password>
  <custom_display_id_config>{"enabled":false,"start":"500","length":"8","prefix":"pre","suffix":"suf"}</custom_display_id_config>
  <affiliate_id>0</affiliate_id>
  <is_maintenance_mode>false</is_maintenance_mode>
  <is_active>true</is_active>
  <first_payment_date></first_payment_date>
  <features>{"allow_transaction_editing": true}</features>
  <date_created>2010-04-24T19:25:02-0700</date_created>
  <date_modified>2013-07-19T11:47:26-0700</date_modified>
</resource>

{
    "class": [
        "store"
    ],
    "properties": {
        "store_version_uri": "https://api.foxycart.com/property_helpers/store_versions/20",
        "store_name": "Example Store",
        "store_domain": "example",
        "use_remote_domain": false,
        "store_url": "https://example.com/catalog",
        "receipt_continue_url": "http://www.example.com/thankyou",
        "store_email": "someone@example.com",
        "from_email": "helpdesk@example.com",
        "bcc_on_receipt_email": false,
        "smtp_config": "{\"username\":\"someone@gmail.com\",\"password\":\"mycomplexpassword\",\"host\":\"smtp.gmail.com\",\"port\":\"465\",\"security\":\"ssl\"}",
        "use_email_dns": false,
        "postal_code": "37211",
        "region": "TN",
        "country": "US",
        "locale_code": "en_US",
        "hide_currency_symbol": false,
        "hide_decimal_characters": false,
        "use_international_currency_symbol": false,
        "language": "english",
        "logo_url": "",
        "checkout_type": "default_account",
        "use_webhook": true,
        "webhook_url": "http://example.com/my_webhook_script",
        "webhook_key": "some super secure password your mom could not not guess",
        "use_cart_validation": false,
        "use_single_sign_on": false,
        "single_sign_on_url": "http://example.com/my_single_sign_on_script",
        "customer_password_hash_type": "phpass",
        "customer_password_hash_config": "8",
        "features_multiship": false,
        "products_require_expires_property": false,
        "app_session_time": 43200,
        "shipping_address_type": "residential",
        "require_signed_shipping_rates": false,
        "timezone": "America/Chicago",
        "unified_order_entry_password": "here I am, buying all your stufz",
        "features": {
            "allow_transaction_editing": true
        },
        "custom_display_id_config": {
        "enabled": true,
        "start": "1",
        "length": "",
        "prefix": "TI-",
        "suffix": "",
        "transaction_journal_entries": {
            "transaction_separator": "-",
            "enabled": true,
            "log_detail_request_types": {
                "transaction_authcapture": {
                    "prefix": "AC-"
                },
                "transaction_refund": {
                    "prefix": "RF-"
                },
                "transaction_capture": {
                    "prefix": "CP-"
                },
                "transaction_void": {
                    "prefix": "VO-"
                }
            }
        }
    },
        "affiliate_id": 0,
        "is_maintenance_mode": false,
        "is_active": true,
        "first_payment_date": null,
        "date_created": "2010-04-24T19:25:02-0700",
        "date_modified": "2013-07-19T11:47:26-0700"
    },
    "links": [
        {
            "rel": [
                "self"
            ],
            "href": "https://api.foxycart.com/stores/2"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/attributes"
            ],
            "href": "https://api.foxycart.com/stores/2/attributes"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/store_version"
            ],
            "href": "https://api.foxycart.com/property_helpers/store_versions/100"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/users"
            ],
            "href": "https://api.foxycart.com/stores/2/users"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/user_accesses"
            ],
            "href": "https://api.foxycart.com/stores/2/user_accesses"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/customers"
            ],
            "href": "https://api.foxycart.com/stores/2/customers"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/carts"
            ],
            "href": "https://api.foxycart.com/stores/2/carts"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/transactions"
            ],
            "href": "https://api.foxycart.com/stores/2/transactions"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/subscriptions"
            ],
            "href": "https://api.foxycart.com/stores/2/subscriptions"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/subscription_settings"
            ],
            "href": "https://api.foxycart.com/store_subscription_settings/2"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/item_categories"
            ],
            "href": "https://api.foxycart.com/stores/2/item_categories"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/taxes"
            ],
            "href": "https://api.foxycart.com/stores/2/taxes"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/payment_method_sets"
            ],
            "href": "https://api.foxycart.com/stores/2/payment_method_sets"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/coupons"
            ],
            "href": "https://api.foxycart.com/stores/2/coupons"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/template_sets"
            ],
            "href": "https://api.foxycart.com/stores/2/template_sets"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/cart_templates"
            ],
            "href": "https://api.foxycart.com/stores/2/cart_templates"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/cart_include_templates"
            ],
            "href": "https://api.foxycart.com/stores/2/cart_include_templates"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/checkout_templates"
            ],
            "href": "https://api.foxycart.com/stores/2/checkout_templates"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/receipt_templates"
            ],
            "href": "https://api.foxycart.com/stores/2/receipt_templates"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/email_templates"
            ],
            "href": "https://api.foxycart.com/stores/2/email_templates"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/error_entries"
            ],
            "href": "https://api.foxycart.com/stores/2/error_entries"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/downloadables"
            ],
            "href": "https://api.foxycart.com/stores/2/downloadables"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/hosted_payment_gateways"
            ],
            "href": "https://api.foxycart.com/stores/2/hosted_payment_gateways"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/fraud_protections"
            ],
            "href": "https://api.foxycart.com/stores/2/fraud_protections"
        }
    ]
}

Zoomable Resources

This resource has no linked resources which can be "zoomed" in on, filtered and embedded within this resource.