Shop

The haravan API's shop object is a collection of the general settings and information about the shop.

#

Only the shop owner can edit this information from inside their shop admin dashboard by navigating to the "Settings" tab and selecting the "General" tab. The API doesn't let you do anything other than retrieve information about a shop.

What can you do with Shop?

The haravan API lets you do the following with the Shop resource. More detailed versions of these general actions may be available:

Shop Properties

address1
{ "address1" : "1 Infinite Loop" }

The shop's street address.

city
{ "city" : "Cupertino" }

The city in which the shop is located.

country
{ "country" : "US" }

The shop's country (by default equal to the two-letter country code).

country_code
{ "country_code" : "US" }

The two-letter country code corresponding to the shop's country.

country_name
{ "country_name" : "United States" }

The shop's normalized country name.

created_at
{ "created_at" : "2007-12-31T19:00:00-05:00" }

The date and time when the shop was created. The API returns this value in ISO 8601 format.

customer_email
{ "customer_email" : "customers@apple.com" }

The customer's email.

currency
{ "currency" : "USD" }

The three-letter code for the currency that the shop accepts.

domain
{ "domain" : "shop.apple.com" }

The shop's domain.

email
{ "email" : "steve@apple.com" }

The contact email address for the shop.

google_apps_domain
{ "google_apps_domain" : "null" }

Feature is present when a shop has a google app domain. It will be returned as a URL. If the shop does not have this feature enabled it will default to "null."

google_apps_login_enabled
{ "google_apps_login_enabled" : "null" }

Feature is present if a shop has google apps enabled. Those shops with this feature will be able to login to the google apps login. Shops without this feature enabled will default to "null."

id
{ "id" : 690933842 }

A unique numeric identifier for the shop.

latitude
{ "latitude" : "45.427408" }

Geographic coordinate specifying the north/south location of a shop.

longitude
{ "longitude" : "-75.68903" }

Geographic coordinate specifying the east/west location of a shop.

money_format
{ "money_format" : "$" }

A string representing the way currency is formatted when the currency isn't specified.

money_with_currency_format
{ "money_with_currency_format" : "$ USD" }

A string representing the way currency is formatted when the currency is specified.

myharavan_domain
{ "myharavan_domain" : "apple.myharavan.com" }

The shop's 'myharavan.com' domain.

name
{ "name" : "Apple Computers" }

The name of the shop.

plan_name
{ "plan_name" : "enterprise" }

The name of the haravan plan the shop is on.

display_plan_name
{ "display_plan_name" : "enterprise" }

The display name of the haravan plan the shop is on.

password_enabled
{ "password_enabled" : false }

Indicates whether the Storefront password protection is enabled.

phone
{ "phone" : "null" }

The contact phone number for the shop.

primary_locale
{ "primary_locale" : "fr" }

The shop's primary locale.

province
{ "province" : "California" }

The shop's normalized province or state name.

province_code
{ "province_code" : "CA" }

The two-letter code for the shop's province or state.

shop_owner
{ "shop_owner" : "Steve Jobs" }

The username of the shop owner.

source
{ "source" : "null" }


tax_shipping
{ "tax_shipping" : "null" }

Specifies wether or not taxes were charged for shipping. Valid values are: "true" or "false."

taxes_included
{ "taxes_included" : "null" }

The setting for whether applicable taxes are included in product prices. Valid values are: "true" or "null."

county_taxes
{ "county_taxes" : "null" }

The setting for whether the shop is applying taxes on a per-county basis or not (US-only). Valid values are: "true" or "null."

timezone
{ "timezone" : "(GMT-05:00) Eastern Time" }

The name of the timezone the shop is in.

iana_timezone
{ "iana_timezone" : "America/New_York" }

The named timezone assigned by the IANA.

zip
{ "zip" : "95014" }

The zip or postal code of the shop's address.

has_storefront
{ "has_storefront" : true }

Indicates whether the shop has web-based storefront or not.

Endpoints

GET/admin/shop.json

Get the configuration of the shop account

fields

comma-separated list of fields to include in the response


GET /admin/shop.json
View Response
HTTP/1.1 200 OK
{
  "shop": {
    "address1": "1 Infinite Loop",
    "city": "Cupertino",
    "country": "US",
    "created_at": "2007-12-31T19:00:00-05:00",
    "customer_email": "customers@apple.com",
    "domain": "shop.apple.com",
    "email": "steve@apple.com",
    "id": 690933842,
    "latitude": 45.45,
    "longitude": -75.43,
    "name": "Apple Computers",
    "phone": "1231231234",
    "primary_locale": "en",
    "primary_location_id": null,
    "province": "California",
    "source": null,
    "zip": "95014",
    "country_code": "US",
    "country_name": "United States",
    "currency": "USD",
    "timezone": "(GMT-05:00) Eastern Time (US & Canada)",
    "iana_timezone": "America\/New_York",
    "shop_owner": "Steve Jobs",
    "money_format": "$ ",
    "money_with_currency_format": "$  USD",
    "province_code": "CA",
    "taxes_included": null,
    "tax_shipping": null,
    "county_taxes": true,
    "plan_display_name": "haravan Plus",
    "plan_name": "enterprise",
    "myharavan_domain": "apple.myharavan.com",
    "google_apps_domain": null,
    "google_apps_login_enabled": null,
    "money_in_emails_format": "$",
    "money_with_currency_in_emails_format": "$ USD",
    "eligible_for_payments": true,
    "requires_extra_payments_agreement": false,
    "password_enabled": false,
    "has_storefront": true
  }
}