Shop

The Shop resource is a collection of the general settings and information about the store.

Shop - 图1

The resource lets you retrieve information about the store but doesn’t let you update any information. Only the merchant can update this information from inside the Shopify admin.

What you can do with Shop

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

Shop properties

address1 plain "address1": "1 Infinite Loop" The shop’s street address.
address2 plain "address2": "Suite 100" The the optional second line of the shop’s street address.
checkout_api_supported plain "checkout_api_supported": true Whether the shop is capable of accepting payments directly through the Checkout API.
city plain "city": "Cupertino" The shop’s city.
country plain "country": "US" The shop’s country. In most cases matches the country_code.
country_code plain "country_code": "US" The two-letter country code corresponding to the shop’s country.
country_name plain "country_name": "United States" The shop’s normalized country name.
county_taxes plain "county_taxes": null Whether the shop is applying taxes on a per-county basis. Only applicable to shops based in the US. Valid values: true or null.”
created_at plain "created_at": "2007-12-31T19:00:00-05:00" The date and time (ISO 8601) when the shop was created.
customer_email plain "customer_email": "customers@apple.com" The contact email used for communication between the shop owner and the customer.
currency plain "currency": "USD" The three-letter code (ISO 4217 format) for the shop’s default currency.
domain plain "domain": "shop.apple.com" The shop’s domain.
enabled_presentment_currencies plain "enabled_presentment_currencies": [ "CAD", "GBP", "USD", "JPY" ] A list of enabled currencies (ISO 4217 format) that the shop accepts. Merchants can enable currencies from their Shopify Payments settings in the Shopify admin.
eligible_for_card_reader_giveaway plain "eligible_for_card_reader_giveaway": true Whether the shop is eligible to receive a free credit card reader from Shopify.
eligible_for_payments plain "eligible_for_payments": true Whether the shop is eligible to use Shopify Payments.
email plain "email": "steve@apple.com" The contact email used for communication between Shopify and the shop owner.
finances DEPRECATED plain "finances": true This field has been deprecated, and is currently unused. Hardcoded to true.
force_ssl plain "force_ssl": true Whether the shop forces requests made to its resources to be made over SSL using the HTTPS protocol. Valid values: true or false.
google_apps_domain plain "google_apps_domain": null The GSuite URL for the store, if applicable.
google_apps_login_enabled plain "google_apps_login_enabled": null Whether the GSuite login is enabled. Shops with this feature will be able to log in through the GSuite login page. Valid values: true, null
has_discounts plain "has_discounts": false Whether any active discounts exist for the shop.
has_gift_cards plain "has_gift_cards": true Whether any active gift cards exist for the shop.
has_storefront plain "has_storefront": true Whether the shop has an online storefront.
iana_timezone plain "iana_timezone": "America/New_York" The name of the timezone assigned by the IANA.
id plain "id": 690933842 The ID for the shop. A 64-bit unsigned integer.
latitude plain "latitude": 45.427408 The latitude of the shop’s location.
longitude plain "longitude": -75.68903 The longitude of the shop’s location.
money_format plain "money_format": "$" A string representing the way currency is formatted when the currency isn’t specified.
money_in_emails_format plain "money_in_emails_format": "$" A string representing the way currency is formatted in email notifications when the currency isn’t specified.
money_with_currency_format plain "money_with_currency_format": "$ USD" A string representing the way currency is formatted when the currency is specified.
money_with_currency_in_emails_format plain "money_with_currency_in_emails_format": "$ USD" A string representing the way currency is formatted in email notifications when the currency is specified.
multi_location_enabled plain "multi_location_enabled": false Whether the shop has enabled multiple locations.
myshopify_domain plain "myshopify_domain": "apple.myshopify.com" The shop’s myshopify.com domain.
name plain "name": "Apple Computers" The name of the shop.
password_enabled plain "password_enabled": false Whether the password protection page is enabled on the online storefront.
phone plain "phone": null The contact phone number for the shop.
plan_display_name plain "plan_display_name": "enterprise" The display name of the Shopify plan the shop is on.
pre_launch_enabled plain "pre_launch_enabled": false Whether the pre-launch page is enabled on the online storefront.
cookie_consent_level plain "cookie_consent_level": "implicit" The cookie consent level defined on the online storefront.
plan_name plain "plan_name": "enterprise" The name of the Shopify plan the shop is on.
primary_locale plain "primary_locale": "fr" The shop’s primary locale, as configured in the language settings of the shop’s theme.
primary_location_id DEPRECATED plain "primary_location_id": 905684977 Formerly used for the ID of the shipping origin location (read only).
Use the Location resource instead.
province plain "province": "California" The shop’s normalized province or state name.
province_code plain "province_code": "CA" The two-letter code for the shop’s province or state.
requires_extra_payments_agreement plain "requires_extra_payments_agreement": false Whether the shop requires an extra Shopify Payments agreement.
setup_required plain "setup_required": false Whether the shop has any outstanding setup steps or not.
shop_owner plain "shop_owner": "Steve Jobs" The username of the shop owner.
source plain "source": null The handle of the partner account that referred the merchant to Shopify, if applicable.
taxes_included plain "taxes_included": null Whether applicable taxes are included in product prices. Valid values: true or null.
tax_shipping plain "tax_shipping": null Whether taxes are charged for shipping. Valid values: true or false.
timezone plain "timezone": "(GMT-05:00) Eastern Time" The name of the timezone the shop is in.
updated_at plain "updated_at": "2007-12-31T19:00:00-05:00" The date and time (ISO 8601) when the shop was last updated.
weight_unit plain "weight_unit": "lb" The default unit of weight measurement for the shop.
zip plain "zip": "95014" The shop’s zip or postal code.

Endpoints

GET/admin/api/2021-01/shop.json Retrieves the shop’s configuration
fields A comma-separated list of fields to include in the response.

Retrieve the shop’s configuration

GET /admin/api/2021-01/shop.json

View Response