API Store

From Spiffy Stores Knowledge Base

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" : "" }

The contact phone number for the shop.




   :phone => @shop.phone,
   :mobile => @shop.mobile,
   :currency => @shop.currency,
   :money_format => @shop.money_format,
   :money_with_currency_format => @shop.money_with_currency_format,
   :password_enabled => @shop.password_enabled,
   :tax_shipping => @shop.tax_shipping,
   :tax_export_shipping => @shop.tax_export_shipping,
   :taxes_included => @shop.taxes_included,
   :timezone => @shop.time_zone,
   :unit_system => @shop.unit_system,
   :tax_number => @shop.tax_number,
   :instalments => @shop.instalments,
   :plan_name => @shop.plan.name,
   :created_at => @shop.account.created_on

GET /api/store.json

Return the settings for the store.