Shop
Returns the Shop resource corresponding to the access token used in the request. The Shop resource contains business and store management settings for the shop.
View-Specific Information
Select
The driver processes all filters client-side within the driver. The following query is the only one processed server side:
SELECT * FROM Shop
Columns
Name | Type | References | Description |
Id [KEY] | String | A globally-unique ID. | |
Name | String | The shop's name. | |
RichTextEditorUrl | String | The URL of the rich text editor that can be used for mobile devices. | |
Description | String | The shop's meta description used in search engine results. | |
String | The shop owner's email address. Shopify will use this email address to communicate with the shop owner. | ||
Url | String | The URL of the shop's online store. | |
ContactEmail | String | The public-facing contact email address for the shop. Customers will use this email to communicate with the shop owner. | |
CurrencyCode | String | The three letter code for the currency that the shop sells in. | |
CustomerAccounts | String | Whether customer accounts are required, optional, or disabled for the shop. | |
IanaTimezone | String | The shop's time zone as defined by the IANA. | |
MyshopifyDomain | String | The shop's . myshopify. com domain name. | |
PublicationCount | Int | The number of publications for the shop. | |
SetupRequired | Bool | Whether the shop has outstanding setup steps. | |
TaxShipping | Bool | Whether the shop charges taxes for shipping. | |
TaxesIncluded | Bool | Whether applicable taxes are included in the shop's product prices. | |
TimezoneAbbreviation | String | The shop's time zone abbreviation. | |
TimezoneOffset | String | The shop's time zone offset. | |
UnitSystem | String | The shop's unit system for weights and measures. | |
WeightUnit | String | The shop's primary unit of weight for products and shipping. | |
CheckoutApiSupported | Bool | Specifies whether the shop supports checkouts via Checkout API. | |
EnabledPresentmentCurrencies | String | The presentment currencies enabled for the shop. | |
ShipsToCountries | String | The list of countries that the shop ships to. | |
TimezoneOffsetMinutes | Int | The shop's time zone offset expressed as a number of minutes. | |
TransactionalSmsDisabled | Bool | Whether transactional SMS sent by Shopify have been disabled for a shop. | |
OrderNumberFormatPrefix | String | The prefix that appears before order numbers. | |
OrderNumberFormatSuffix | String | The suffix that appears after order numbers. | |
BillingAddressId | String | A globally-unique ID. | |
BillingAddressCoordinatesValidated | Bool | Whether the address coordinates are valid. | |
BillingAddressAddress1 | String | The first line of the address. Typically the street address or PO Box number. | |
BillingAddressAddress2 | String | The second line of the address. Typically the number of the apartment, suite, or unit. | |
BillingAddressCity | String | The name of the city, district, village, or town. | |
BillingAddressCompany | String | The name of the company or organization. | |
BillingAddressCountry | String | The name of the country. | |
BillingAddressLatitude | Double | The latitude coordinate of the address. | |
BillingAddressLongitude | Double | The longitude coordinate of the address. | |
BillingAddressPhone | String | A phone number associated with the address. Formatted using E. 164 standard. For example, _+16135551111_. | |
BillingAddressProvince | String | The region of the address, such as the province, state, or district. | |
BillingAddressZip | String | The zip or postal code of the address. | |
BillingAddressFormattedArea | String | A comma-separated list of the values for city, province, and country. | |
BillingAddressProvinceCode | String | The two-letter code for the region. For example, ON. | |
BillingAddressCountryCodeV2 | String | The two-letter code for the country of the address. For example, US. | |
CountriesInShippingZonesCountryCodes | String | The list of all the countries from all the combined shipping zones. | |
CountriesInShippingZonesIncludeRestOfWorld | Bool | Whether 'Rest of World' has been defined in any of the shipping zones. | |
CurrencyFormatsMoneyFormat | String | Money without currency in HTML. | |
CurrencyFormatsMoneyInEmailsFormat | String | Money without currency in emails. | |
CurrencyFormatsMoneyWithCurrencyFormat | String | Money with currency in HTML. | |
CurrencyFormatsMoneyWithCurrencyInEmailsFormat | String | Money with currency in emails. | |
FeaturesInternationalPriceOverrides | Bool | Whether a shop can enable international price overrides. | |
FeaturesBranding | String | The branding of the shop, which influences its look and feel in the Shopify admin. | |
FeaturesCaptcha | Bool | Whether a shop's online store can have CAPTCHA protection. | |
FeaturesReports | Bool | Whether a shop has access to all reporting features. | |
FeaturesStorefront | Bool | Whether a shop has an online store. | |
FeaturesAvalaraAvatax | Bool | Whether a shop has access to Avalara AvaTax. | |
FeaturesDynamicRemarketing | Bool | Whether a shop has access to the Google Analytics dynamic remarketing feature. | |
FeaturesGiftCards | Bool | Whether a shop can create gift cards. | |
FeaturesInternationalDomains | Bool | Whether a shop can enable international domains. | |
FeaturesLiveView | Bool | Whether to show the Live View metrics in the Shopify admin. Live view is hidden from merchants that are on a trial or don't have a storefront. | |
FeaturesSellsSubscriptions | Bool | Whether a shop has ever had subscription products. | |
FeaturesShowMetrics | Bool | Whether to show metrics in the Shopify admin. Metrics are hidden for new merchants until they become meaningful. | |
FeaturesCaptchaExternalDomains | Bool | Whether a shop's online store can have CAPTCHA protection for domains not managed by Shopify. | |
FeaturesEligibleForSubscriptions | Bool | Whether a shop is configured properly to sell subscriptions. | |
FeaturesHarmonizedSystemCode | Bool | Whether a shop displays Harmonized System codes on products. This is used for customs when shipping internationally. | |
FeaturesInternationalPriceRules | Bool | Whether a shop can enable international price rules. | |
FeaturesEligibleForSubscriptionMigration | Bool | Whether a shop can be migrated to use Shopify subscriptions. | |
FeaturesLegacySubscriptionGatewayEnabled | Bool | Whether a shop has enabled a legacy subscription gateway to handle older subscriptions. | |
FeaturesPaypalExpressSubscriptionGatewayStatus | String | Whether a shop is configured to sell subscriptions with PayPal Express. | |
LimitedPendingOrderCountCount | Int | The number of pendings orders on the shop. Limited to a maximum of 10000. | |
LimitedPendingOrderCountAtMax | Bool | This is set when the number of pending orders has reached the maximum. | |
PaymentSettingsSupportedDigitalWallets | String | List of the digital wallets which the shop supports. | |
PlanDisplayName | String | The name of the shop's billing plan. | |
PlanPartnerDevelopment | Bool | Whether the shop is a partner development shop for testing purposes. | |
PlanShopifyPlus | Bool | Whether the shop has a Shopify Plus subscription. | |
PrimaryDomainId | String | A globally-unique ID. | |
PrimaryDomainHost | String | The host name of the domain. For example, 'example. com'. | |
PrimaryDomainUrl | String | The URL of the domain (for example, 'https: //example. com'). | |
PrimaryDomainSslEnabled | Bool | Whether SSL is enabled. | |
PrimaryDomainLocalizationCountry | String | The ISO code for the country assigned to the domain. For example, 'CA' or '*' for a domain set to 'Rest of world'. | |
PrimaryDomainLocalizationAlternateLocales | String | The ISO codes for the domain's alternate locales. For example, '['en']'. | |
PrimaryDomainLocalizationDefaultLocale | String | The ISO code for the domain's default locale. For example, 'en'. | |
PrimaryDomainMarketWebPresenceId | String | A globally-unique ID. | |
PrimaryDomainMarketWebPresenceAlternateLocales | String | The ISO codes for the alternate locales. When a domain is used, these locales will be available as language-specific subfolders. For example, if English is an alternate locale, and 'example. ca' is the market's domain, then 'example. ca/en' will load in English. | |
PrimaryDomainMarketWebPresenceDefaultLocale | String | The ISO code for the default locale. When a domain is used, this is the locale that will be used when the domain root is accessed. For example, if French is the default locale, and 'example. ca' is the market's domian, then 'example. ca' will load in French. | |
PrimaryDomainMarketWebPresenceSubfolderSuffix | String | The market-specific suffix of the subfolders defined by the web presence. Example: in '/en-us' the subfolder suffix is 'us'. This field will be null if 'domain' isn't null. | |
ResourceLimitsLocationLimit | Int | Maximum number of locations allowed. | |
ResourceLimitsMaxProductOptions | Int | Maximum number of product options allowed. | |
ResourceLimitsMaxProductVariants | Int | The maximum number of variants allowed per product. | |
ResourceLimitsRedirectLimitReached | Bool | Whether the shop has reached the limit of the number of URL redirects it can make for resources. |