latestSwagger 2.0ShopBase Dev 1.02026-08-10153268547.4 KB

353ccde6240d

Shop

Retrieves shop.

get/admin/shop.json

Response

address1string

The shop's street address.

address2string

The the optional second line of the shop's street address.

citystring

The shop's city.

countrystring

The shop's country. In most cases matches the country_code.

country_codestring

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

country_namestring

The shop's normalized country name.

county_taxesboolean

Whether the shop is applying taxes on a per-county basis. Only applicable to shops based in the US. Valid values: true or false.

created_atinteger

The timestamp when the shop was created.

currencystring

The three-letter code (ISO 4217 format) for the shop's default currency.

current_active_storefrontinteger

customer_emailstring

The contact email used for communication between the shop owner and the customer.

domainstring

The shop's onshopbase.com domain.

emailstring

The contact email used for communication between ShopBase and the shop owner.

enableboolean

enable_multi_storefrontboolean

enable_onboarding_multi_sfboolean

end_free_trial_atinteger

The timestamp when the shop's free trial was ended.

iana_timezonestring

The name of the timezone assigned by the IANA.

idinteger

A unique identifier for the shop.

latitudenumber

The latitude of the shop's location.

longitudenumber

The longitude of the shop's location.

max_free_storefrontinteger

money_formatstring

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

money_in_emails_formatstring

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

money_with_currency_formatstring

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

money_with_currency_in_emails_formatstring

A string representing the way currency is formatted in email notifications when the currency is specified.

multi_storefrontinteger

namestring

The name of the shop.

online_store_enableinteger

onshopbase_domainstring

The shop's onshopbase.com domain.

parent_idinteger

password_enabledboolean

Whether the password protection page is enabled on the online storefront.

phonestring

The contact phone number for the shop.

primary_domainstring

The shop's domain.

primary_localestring

The shop's primary locale, as configured in the language settings of the shop's theme.

provincestring

The shop's normalized province or state name.

province_codestring

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

shop_ownerstring

The username of the shop owner.

sourcestring

storefront_feenumber

storefront_freeboolean

subscription_expired_atinteger

The timestamp when the shop was expired.

tax_shippingboolean

Whether taxes are charged for shipping. Valid values: true or false.

taxes_includedboolean

Whether applicable taxes are included in product prices. Valid values: true or false.

timezonestring

The name of the timezone the shop is in.

updated_atinteger

The timestamp when the shop was last updated.

used_free_storefrontinteger

weight_unitstring

The default unit of weight measurement for the shop.

zipstring

The shop's zip or postal code.

Example response

{
  "address1": "127 Altenwerth",
  "address2": "Suite 100",
  "city": "Hanoi",
  "country": "US",
  "country_code": "US",
  "country_name": "United States",
  "county_taxes": true,
  "created_at": 1561694636,
  "currency": "USD",
  "customer_email": "email@shopbase.com",
  "domain": "apple.onshopbase.com",
  "email": "steve@job.com",
  "end_free_trial_at": 1561694636,
  "iana_timezone": "America/Los_Angeles",
  "id": 107333978,
  "latitude": 45.427408,
  "longitude": -75.68903,
  "money_format": "$",
  "money_in_emails_format": "$",
  "money_with_currency_format": "$ USD",
  "money_with_currency_in_emails_format": "$ USD",
  "name": "The Apple Store",
  "onshopbase_domain": "apple.onshopbase.com",
  "password_enabled": true,
  "phone": "+1 (979) 825 5365",
  "primary_domain": "apple.com",
  "primary_locale": "fr",
  "province": "California",
  "province_code": "CA",
  "shop_owner": "Santa Claus",
  "subscription_expired_at": 1561694636,
  "taxes_included": true,
  "timezone": "(GMT-05:00) Eastern Time",
  "updated_at": 1561694636,
  "weight_unit": "lb",
  "zip": "100000"
}