---
title: Shop
description: Access a store's general settings and information as configured by the merchant in their Shopify admin.
api_version: 2025-10
api_name: admin-rest
api_type: rest
source_url:
  html: https://shopify.dev/docs/api/admin-rest/latest/resources/shop
  md: https://shopify.dev/docs/api/admin-rest/latest/resources/shop.md
---

![](https://shopify.dev/images/logos/GraphQL.svg)![](https://shopify.dev/images/logos/GraphQL-dark.svg)

The REST Admin API is a legacy API as of October 1, 2024. Starting April 1, 2025, all new public apps must be built exclusively with the [GraphQL Admin API](https://shopify.dev/docs/api/admin-graphql). For details and migration steps, visit our [migration guide](https://shopify.dev/docs/apps/build/graphql/migrate).

# Shop

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.

\#

## Endpoints

* [get](https://shopify.dev/docs/api/admin-rest/latest/resources/shop#get-shop)

  [/admin/api/latest/shop.​json](https://shopify.dev/docs/api/admin-rest/latest/resources/shop#get-shop)

  Retrieves the shop's configuration

  [![](https://shopify.dev/images/logos/GraphQL.svg)![](https://shopify.dev/images/logos/GraphQL-dark.svg)](https://shopify.dev/docs/api/admin-graphql/latest/queries/shop?example=retrieves-the-shops-configuration)

  [shop](https://shopify.dev/docs/api/admin-graphql/latest/queries/shop?example=retrieves-the-shops-configuration)

***

## The Shop resource

### Properties

***

address1

->

[![](https://shopify.dev/images/logos/GraphQL.svg)![](https://shopify.dev/images/logos/GraphQL-dark.svg)](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopAddress#field-ShopAddress.fields.address1)

[address1](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopAddress#field-ShopAddress.fields.address1)

The shop's street address.

***

address2

->

[![](https://shopify.dev/images/logos/GraphQL.svg)![](https://shopify.dev/images/logos/GraphQL-dark.svg)](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopAddress#field-ShopAddress.fields.address2)

[address2](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopAddress#field-ShopAddress.fields.address2)

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

***

auto\_configure\_tax\_inclusivity

deprecated

The setting for whether applicable taxes are included automatically, based on buyer's location.

***

checkout\_api\_supported

->

[![](https://shopify.dev/images/logos/GraphQL.svg)![](https://shopify.dev/images/logos/GraphQL-dark.svg)](https://shopify.dev/docs/api/admin-graphql/latest/objects/Shop#field-Shop.fields.checkoutApiSupported)

[checkoutApiSupported](https://shopify.dev/docs/api/admin-graphql/latest/objects/Shop#field-Shop.fields.checkoutApiSupported)

Whether the shop is capable of accepting payments directly through the [Checkout API](https://shopify.dev/docs/api/admin-rest/current/resources/checkout).

***

city

->

[![](https://shopify.dev/images/logos/GraphQL.svg)![](https://shopify.dev/images/logos/GraphQL-dark.svg)](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopAddress#field-ShopAddress.fields.city)

[city](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopAddress#field-ShopAddress.fields.city)

The shop's city.

***

country

->

[![](https://shopify.dev/images/logos/GraphQL.svg)![](https://shopify.dev/images/logos/GraphQL-dark.svg)](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopAddress#field-ShopAddress.fields.country)

[country](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopAddress#field-ShopAddress.fields.country)

The shop's country. In most cases, this value matches the `country_code`.

***

country\_code

->

[![](https://shopify.dev/images/logos/GraphQL.svg)![](https://shopify.dev/images/logos/GraphQL-dark.svg)](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopAddress#field-ShopAddress.fields.countryCodeV2)

[countryCodeV2](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopAddress#field-ShopAddress.fields.countryCodeV2)

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

***

country\_name

->

[![](https://shopify.dev/images/logos/GraphQL.svg)![](https://shopify.dev/images/logos/GraphQL-dark.svg)](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopAddress#field-ShopAddress.fields.country)

[country](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopAddress#field-ShopAddress.fields.country)

The shop's normalized country name.

***

county\_taxes

boolean

deprecated

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

->

[![](https://shopify.dev/images/logos/GraphQL.svg)![](https://shopify.dev/images/logos/GraphQL-dark.svg)](https://shopify.dev/docs/api/admin-graphql/latest/objects/Shop#field-Shop.fields.createdAt)

[createdAt](https://shopify.dev/docs/api/admin-graphql/latest/objects/Shop#field-Shop.fields.createdAt)

The date and time ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when the shop was created.

***

customer\_email

->

[![](https://shopify.dev/images/logos/GraphQL.svg)![](https://shopify.dev/images/logos/GraphQL-dark.svg)](https://shopify.dev/docs/api/admin-graphql/latest/objects/Shop#field-Shop.fields.contactEmail)

[contactEmail](https://shopify.dev/docs/api/admin-graphql/latest/objects/Shop#field-Shop.fields.contactEmail)

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

***

currency

->

[![](https://shopify.dev/images/logos/GraphQL.svg)![](https://shopify.dev/images/logos/GraphQL-dark.svg)](https://shopify.dev/docs/api/admin-graphql/latest/objects/Shop#field-Shop.fields.currencyCode)

[currencyCode](https://shopify.dev/docs/api/admin-graphql/latest/objects/Shop#field-Shop.fields.currencyCode)

The three-letter code ([ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format) for the shop's default currency.

***

{}

## The Shop resource

```json
{
  "address1": "1 Infinite Loop",
  "address2": "Suite 100",
  "auto_configure_tax_inclusivity": true,
  "checkout_api_supported": true,
  "city": "Cupertino",
  "country": "US",
  "country_code": "US",
  "country_name": "United States",
  "county_taxes": null,
  "created_at": "2007-12-31T19:00:00-05:00",
  "customer_email": "customers@apple.com",
  "currency": "USD",
  "domain": "shop.apple.com",
  "enabled_presentment_currencies": [
    "CAD",
    "GBP",
    "USD",
    "JPY"
  ],
  "eligible_for_payments": true,
  "email": "j.smith@example.com",
  "finances": true,
  "force_ssl": true,
  "google_apps_domain": null,
  "google_apps_login_enabled": null,
  "has_discounts": false,
  "has_gift_cards": true,
  "has_storefront": true,
  "iana_timezone": "America/New_York",
  "id": 548380009,
  "latitude": 45.427408,
  "longitude": -75.68903,
  "money_format": "${{amount}}",
  "money_in_emails_format": "${{amount}}",
  "money_with_currency_format": "${{amount}} USD",
  "money_with_currency_in_emails_format": "${{amount}} USD",
  "multi_location_enabled": true,
  "myshopify_domain": "jsmith.myshopify.com",
  "name": "John Smith Test Store",
  "password_enabled": false,
  "phone": null,
  "plan_display_name": "enterprise",
  "pre_launch_enabled": false,
  "plan_name": "enterprise",
  "primary_locale": "fr",
  "primary_location_id": 905684977,
  "province": "California",
  "province_code": "CA",
  "requires_extra_payments_agreement": false,
  "setup_required": false,
  "shop_owner": "John Smith",
  "source": null,
  "taxes_included": null,
  "tax_shipping": null,
  "timezone": "(GMT-05:00) Eastern Time",
  "transactional_sms_disabled": false,
  "updated_at": "2007-12-31T19:00:00-05:00",
  "weight_unit": "lb",
  "zip": "95014",
  "marketing_sms_consent_enabled_at_checkout": true
}
```

***

## getRetrieves the shop's configuration

[![](https://shopify.dev/images/logos/GraphQL.svg)![](https://shopify.dev/images/logos/GraphQL-dark.svg)](https://shopify.dev/docs/api/admin-graphql/latest/queries/shop?example=retrieves-the-shops-configuration)

[shop](https://shopify.dev/docs/api/admin-graphql/latest/queries/shop?example=retrieves-the-shops-configuration)

Retrieves the shop's configuration

### Parameters

***

api\_version

string

required

***

fields

A comma-separated list of fields to include in the response.

***

### Examples

Retrieve the shop's configuration

Retrieve the shop's mailing address

Query parameters

fields=​address1,​address2,​city,​province,​country

A comma-separated list of fields to include in the response.

get

## /admin/api/2025-10/shop.​json

```bash
curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-10/shop.json" \
-H "X-Shopify-Access-Token: {access_token}"
```

{}

## Response

JSON

```json
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-10-01T14:56:25-04: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
  }
}
```

### examples

* #### Retrieve the shop's configuration

  #####

  ```curl
  curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-10/shop.json" \
  -H "X-Shopify-Access-Token: {access_token}"
  ```

  #####

  ```remix
  await admin.rest.resources.Shop.all({
    session: session,
  });
  ```

  #####

  ```ruby
  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session

  ShopifyAPI::Shop.all(
    session: test_session,
  )
  ```

  #####

  ```node
  // Session is built by the OAuth process

  await shopify.rest.Shop.all({
    session: session,
  });
  ```

  #### response

  ```json
  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-10-01T14:56:25-04: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

  #####

  ```curl
  curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-10/shop.json?fields=address1%2Caddress2%2Ccity%2Cprovince%2Ccountry" \
  -H "X-Shopify-Access-Token: {access_token}"
  ```

  #####

  ```remix
  await admin.rest.resources.Shop.all({
    session: session,
    fields: "address1,address2,city,province,country",
  });
  ```

  #####

  ```ruby
  # Session is activated via Authentication
  test_session = ShopifyAPI::Context.active_session

  ShopifyAPI::Shop.all(
    session: test_session,
    fields: "address1,address2,city,province,country",
  )
  ```

  #####

  ```node
  // Session is built by the OAuth process

  await shopify.rest.Shop.all({
    session: session,
    fields: "address1,address2,city,province,country",
  });
  ```

  #### response

  ```json
  HTTP/1.1 200 OK{"shop":{"province":"California","country":"US","address1":"1 Infinite Loop","city":"Cupertino","address2":"Suite 100"}}
  ```