# Shop <p>The Shop resource is a collection of general business and store management settings and information about the store. The resource lets you retrieve information about the store, but it doesn't let you update any information. Only the merchant can update this information from inside the Shopify admin.</p> ## Resource Properties ### Shop * address1: The shop's street address. * Type: x-string * Example: "1 Infinite Loop" * address2: The optional second line of the shop's street address. * Type: x-string * Example: "Suite 100" * auto_configure_tax_inclusivity: The setting for whether applicable taxes are included automatically, based on buyer's location. * Type: x-string * Example: true * checkout_api_supported: Whether the shop is capable of accepting payments directly through the <a href="/docs/api/admin-rest/current/resources/checkout">Checkout API</a>. * Type: x-string * Example: true * city: The shop's city. * Type: x-string * Example: "Cupertino" * country: The shop's country. In most cases, this value matches the <code>country_code</code>. * Type: x-string * Example: "US" * country_code: The two-letter country code corresponding to the shop's country. * Type: x-string * Example: "US" * country_name: The shop's normalized country name. * Type: x-string * Example: "United States" * county_taxes: Whether the shop is applying taxes on a per-county basis. Only applicable to shops based in the US. Valid values: <code>true</code> or <code>null</code>." * Type: boolean * Example: nil * created_at: The date and time (<a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a>) when the shop was created. * Type: x-string * Example: "2007-12-31T19:00:00-05:00" * customer_email: The contact email used for communication between the shop owner and the customer. * Type: x-string * Example: "customers@apple.com" * currency: The three-letter code (<a href="https://en.wikipedia.org/wiki/ISO_4217">ISO 4217</a> format) for the shop's default currency. * Type: x-string * Example: "USD" * domain: The shop's domain. * Type: x-string * Example: "shop.apple.com" * enabled_presentment_currencies: A list of enabled currencies (<a href="https://en.wikipedia.org/wiki/ISO_4217">ISO 4217</a> format) that the shop accepts. Merchants can enable currencies from their Shopify Payments settings in the Shopify Admin. * Type: x-string * Example: ["CAD", "GBP", "USD", "JPY"] * eligible_for_payments: Whether the shop is eligible to use Shopify Payments. * Type: x-string * Example: true * email: The contact email used for communication between Shopify and the shop owner. * Type: x-string * Example: "j.smith@example.com" * finances: This field has been deprecated, and is currently unused. Hardcoded to <code>true</code>. * Type: x-string * Example: true * force_ssl: As of API version 2021-07, this field has been deprecated and is currently unused. Previously indicated whether the shop forced requests made to its resources to be made over SSL using the HTTPS protocol. All requests now use HTTPS, so <code>force_ssl</code> is always <code>true</code>. * Type: x-string * Example: true * google_apps_domain: The GSuite URL for the store, if applicable. * Type: x-string * Example: nil * google_apps_login_enabled: Whether the GSuite login is enabled. Shops with this feature will be able to log in through the GSuite login page. Valid values: <code>true</code>, <code>null</code> * Type: x-string * Example: nil * has_discounts: Whether any active discounts exist for the shop. * Type: x-string * Example: false * has_gift_cards: Whether any active gift cards exist for the shop. * Type: x-string * Example: true * has_storefront: Whether the shop has an online store. * Type: x-string * Example: true * iana_timezone: The name of the timezone assigned by the <a href="http://www.iana.org/time-zones" target="_blank">IANA</a>. * Type: x-string * Example: "America/New_York" * id: The ID for the shop. A 64-bit unsigned integer. * Type: x-string * Example: 548380009 * latitude: The latitude of the shop's location. * Type: x-string * Example: 45.427408 * longitude: The longitude of the shop's location. * Type: x-string * Example: -75.68903 * money_format: A string representing the way currency is formatted when the currency isn't specified. * Type: x-string * Example: "${{amount}}" * money_in_emails_format: A string representing the way currency is formatted in email notifications when the currency isn't specified. * Type: x-string * Example: "${{amount}}" * money_with_currency_format: A string representing the way currency is formatted when the currency is specified. * Type: x-string * Example: "${{amount}} USD" * money_with_currency_in_emails_format: A string representing the way currency is formatted in email notifications when the currency is specified. * Type: x-string * Example: "${{amount}} USD" * multi_location_enabled: This field has been deprecated, and is currently unused. Hardcoded to <code>true</code>. * Type: x-string * Example: true * myshopify_domain: The shop's .myshopify.com domain. * Type: x-string * Example: "jsmith.myshopify.com" * name: The name of the shop. * Type: x-string * Example: "John Smith Test Store" * password_enabled: Whether the password protection page is enabled on the shop's online store. * Type: x-string * Example: false * phone: The contact phone number for the shop. * Type: x-string * Example: nil * plan_display_name: The display name of the Shopify plan the shop is on. * Type: x-string * Example: "enterprise" * pre_launch_enabled: Whether the pre-launch page is enabled on the shop's online store. * Type: x-string * Example: false * plan_name: The name of the Shopify plan the shop is on. * Type: x-string * Example: "enterprise" * primary_locale: The shop's primary locale, as configured in the language settings of the shop's theme. * Type: x-string * Example: "fr" * primary_location_id: Formerly used for the ID of the shipping origin location (read only). * Type: x-string * Example: 905684977 * province: The shop's normalized province or state name. * Type: x-string * Example: "California" * province_code: The two- or three-letter code for the shop's province or state. * Type: x-string * Example: "CA" * requires_extra_payments_agreement: Whether the shop requires an extra Shopify Payments agreement. * Type: x-string * Example: false * setup_required: Whether the shop has any outstanding setup steps. * Type: x-string * Example: false * shop_owner: The name of the shop owner. * Type: x-string * Example: "John Smith" * source: The handle of the partner account that referred the merchant to Shopify, if applicable. * Type: x-string * Example: nil * taxes_included: Whether applicable taxes are included in product prices. Valid values: <code>true</code> or <code>null</code>. * Type: boolean * Example: nil * tax_shipping: Whether taxes are charged for shipping. Valid values: <code>true</code> or <code>false</code>. * Type: x-string * Example: nil * timezone: The name of the timezone the shop is in. * Type: x-string * Example: "(GMT-05:00) Eastern Time" * transactional_sms_disabled: Whether transactional SMS sent by Shopify are disabled on the shop's online store. * Type: x-string * Example: false * updated_at: The date and time (<a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a>) when the shop was last updated. * Type: x-string * Example: "2007-12-31T19:00:00-05:00" * weight_unit: The default unit of weight measurement for the shop. * Type: x-string * Example: "lb" * zip: The shop's zip or postal code. * Type: x-string * Example: "95014" * marketing_sms_consent_enabled_at_checkout: Whether SMS marketing has been enabled on the shop's checkout configuration settings. * Type: x-string * Example: true ## Retrieves the shop's configuration Retrieves the shop's configuration ### Endpoint /admin/api/#{api_version}/shop.json (GET) ### Parameters * api_version (required): * fields: A comma-separated list of fields to include in the response. ### Responses #### 200 Retrieves the shop's configuration Examples: ##### Retrieve the shop's configuration Request: ``` GET /admin/api/unstable/shop.json ``` Response: ``` HTTP/1.1 200 OK {"shop":{"id":548380009,"name":"John Smith Test Store","email":"j.smith@example.com","domain":"shop.apple.com","province":"California","country":"US","address1":"1 Infinite Loop","zip":"95014","city":"Cupertino","source":null,"phone":"1231231234","latitude":45.45,"longitude":-75.43,"primary_locale":"en","address2":"Suite 100","created_at":"2007-12-31T19:00:00-05:00","updated_at":"2025-01-02T11:35:33-05:00","country_code":"US","country_name":"United States","currency":"USD","customer_email":"customers@apple.com","timezone":"(GMT-05:00) Eastern Time (US & Canada)","iana_timezone":"America/New_York","shop_owner":"John Smith","money_format":"${{amount}}","money_with_currency_format":"${{amount}} USD","weight_unit":"lb","province_code":"CA","taxes_included":null,"auto_configure_tax_inclusivity":null,"tax_shipping":null,"county_taxes":true,"plan_display_name":"Shopify Plus","plan_name":"enterprise","has_discounts":true,"has_gift_cards":true,"myshopify_domain":"jsmith.myshopify.com","google_apps_domain":null,"google_apps_login_enabled":null,"money_in_emails_format":"${{amount}}","money_with_currency_in_emails_format":"${{amount}} USD","eligible_for_payments":true,"requires_extra_payments_agreement":false,"password_enabled":false,"has_storefront":true,"finances":true,"primary_location_id":655441491,"checkout_api_supported":true,"multi_location_enabled":true,"setup_required":false,"pre_launch_enabled":false,"enabled_presentment_currencies":["USD"],"marketing_sms_consent_enabled_at_checkout":false,"transactional_sms_disabled":false}} ``` ##### Retrieve the shop's mailing address Request: ``` GET /admin/api/unstable/shop.json ``` Response: ``` HTTP/1.1 200 OK {"shop":{"province":"California","country":"US","address1":"1 Infinite Loop","city":"Cupertino","address2":"Suite 100"}} ```