API Store

The Spiffy Stores API Store object returns information about the store's settings and how it is configured.

These settings are managed from the Spiffy Stores Toolbox and can only be changed there. The API only allows you to read the settings.

Store Properties

id	{ "id" : 123456789 } A unique numeric identifier for the store.
name	{ "name" : "Make Lots of Money with Spiffy Stores" } The name of the store.
domain	{ "domain" : "shop.stuff-galore.com" } The store's domain name.
spiffystores_domain	{ "spiffystores_domain" : "stuff-galore.spiffystores.com" } The store's "spiffystores.com" domain name.
store_owner	{ "store_owner" : "Austin Powers" } The name of the store owner.
email	{ "email" : "sales@stuff-galore.com" } The contact email address for the store.
customer_email	{ "customer_email" : "austin@stuff-galore.com" } The customer's email address.
address1	{ "address1" : "123 Main Street" } The store's street address.
city	{ "city" : "Large City" } The store's city address.
region	{ "region" : "New South Wales" } The store's region or state name.
region_code	{ "region_code" : "NSW" } The standard ISO code for the store's region or state.
country	{ "country" : "Australia" } The store's country.
country_code	{ "country_code" : "AU" } The standard ISO code for the store's country.
postal_code	{ "postal_code" : "2000" } The store's postal code.
phone	{ "phone" : "0211111111" } The contact phone number for the store.
mobile	{ "mobile" : "0412111111" } The contact mobile number for the store.
currency	{ "currency" : "AUD" } The three-letter code for the store's currency. All transactions are carried out in this currency.
money_format	{ "money_format" : "${{amount}}" } The format string used to format a currency amount without a currency denomination.
money_with_currency_format	{ "money_with_currency_format" : "${{amount}} AUD" } The format string used to format a currency amount including a currency denomination.
password_enabled	{ "password_enabled" : false } Indicates whether store-front password protection is enabled.
tax_shipping	{ "tax_shipping" : true } Indicates whether taxes are applied to shipping rates.
tax_export_shipping	{ "tax_export_shipping" : false } Indicates whether taxes are applied to overseas shipping rates.
taxes_included	{ "taxes_included" : true } Indicates whether taxes are included in product prices as with a GST or VAT system, or whether taxes are added in addition to the product price as in the case of a Sales Tax.
tax_rate	{ "tax_rate" : 0.1 } Return the default sales tax rate for the store, based upon the country in which it is operating.
timezone	{ "timezone" : "Australia/Sydney" } The name of the store's local timezone.
unit_system	{ "unit_system" : "metric" } The system of weights and measures used by the store. This is either "metric" or "imperial".
tax_number	{ "tax_number" : "ABN 11 222 333 444" } This is the tax number for the store that is required to be displayed on tax invoices.
instalments	{ "instalments" : false } Indicates whether the store supports instalment pricing for products.
plan_name	{ "plan_name" : "Business" } The name of the Spiffy Stores plan that is currently active for the store.
created_at	{ "created_at" : "2007-10-24T06:15:00.123+10:00" } The date and time when the store was created. The timestamp is in ISO 8601 format.
force_ssl	{ "force_ssl" : true } If the store has enabled Storefront SSL, then all requests will be redirected to a secure HTTPS session.

Endpoints

GET /api/store.json

Return the store's settings.

Optional Parameters

fields	A comma-separated list of fields to return in the response.

Example Request and Response

GET /api/store.json

HTTP/1.1 200 OK

{
  "store": {
    "id": 123456789,
    "name": "Make Lots of Money with Spiffy Stores",
    "domain": "shop.stuff-galore.com",
    "spiffystores_domain": "stuff-galore.spiffystores.com",
    "store_owner": "Austin Powers",
    "email": "sales@stuff-galore.com",
    "customer_email": "austin@stuff-galore.com",
    "address1": "123 Main Street",
    "city": "Large City",
    "region": "New South Wales",
    "region_code": "NSW",
    "country": "Australia",
    "country_code": "AU",
    "postal_code": "2000",
    "phone": "0211111111",
    "mobile": "0412111111",
    "currency": "AUD",
    "money_format": "${{amount}}",
    "money_with_currency_format": "${{amount}} AUD",
    "password_enabled": false,
    "tax_shipping": true,
    "tax_export_shipping": false,
    "taxes_included": true,
    "timezone": "Australia/Sydney",
    "unit_system": "metric",
    "tax_number": "ABN 11 222 333 444",
    "instalments": false,
    "plan_name": "Business",
    "created_at": "2007-10-24T06:15:00Z",
    "force_ssl": true
  }
}

Further Reference

• An Introduction to the Spiffy Stores API
• Creating Private API Keys
• Using the API
• API Reference