Shop
The Shop resource is a collection of the general settings and information about the store.
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 |
The shop's street address. |
| address2 |
The the optional second line of the shop's street address. |
| checkout_api_supported |
Whether the shop is capable of accepting payments directly through the Checkout API. |
| city |
The shop's city. |
| country |
The shop's country. In most cases matches the |
| country_code |
The two-letter country code corresponding to the shop's country. |
| country_name |
The shop's normalized country name. |
| county_taxes |
Whether the shop is applying taxes on a per-county basis. Only applicable to shops based in the US. Valid values: |
| created_at |
The date and time (ISO 8601) when the shop was created. |
| customer_email |
The contact email used for communication between the shop owner and the customer. |
| currency |
The three-letter code (ISO 4217 format) for the shop's default currency. |
| domain |
The shop's domain. |
| enabled_presentment_currencies |
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 |
Whether the shop is eligible to receive a free credit card reader from Shopify. |
| eligible_for_payments |
Whether the shop is eligible to use Shopify Payments. |
The contact email used for communication between Shopify and the shop owner. |
|
|
finances
deprecated |
This field has been deprecated, and is currently unused. Hardcoded to |
| force_ssl |
Whether the shop forces requests made to its resources to be made over SSL using the HTTPS protocol. Valid values: |
| google_apps_domain |
The GSuite URL for the store, if applicable. |
| 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: |
| has_discounts |
Whether any active discounts exist for the shop. |
| has_gift_cards |
Whether any active gift cards exist for the shop. |
| has_storefront |
Whether the shop has an online storefront. |
| iana_timezone |
The name of the timezone assigned by the IANA. |
| id |
The ID for the shop. A 64-bit unsigned integer. |
| latitude |
The latitude of the shop's location. |
| longitude |
The longitude of the shop's location. |
| money_format |
A string representing the way currency is formatted when the currency isn't specified. |
| 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 |
A string representing the way currency is formatted when the currency is specified. |
| money_with_currency_in_emails_format |
A string representing the way currency is formatted in email notifications when the currency is specified. |
| multi_location_enabled |
Whether the shop has enabled multiple locations. |
| myshopify_domain |
The shop's myshopify.com domain. |
| name |
The name of the shop. |
| password_enabled |
Whether the password protection page is enabled on the online storefront. |
| phone |
The contact phone number for the shop. |
| plan_display_name |
The display name of the Shopify plan the shop is on. |
| pre_launch_enabled |
Whether the pre-launch page is enabled on the online storefront. |
| plan_name |
The name of the Shopify plan the shop is on. |
| primary_locale |
The shop's primary locale, as configured in the language settings of the shop's theme. |
|
primary_location_id
deprecated |
Formerly used for the ID of the shipping origin location (read only). Use the Location resource instead. |
| province |
The shop's normalized province or state name. |
| province_code |
The two-letter code for the shop's province or state. |
| requires_extra_payments_agreement |
Whether the shop requires an extra Shopify Payments agreement. |
| setup_required |
Whether the shop has any outstanding setup steps or not. |
| shop_owner |
The username of the shop owner. |
| source |
The handle of the partner account that referred the merchant to Shopify, if applicable. |
| taxes_included |
Whether applicable taxes are included in product prices. Valid values: |
| tax_shipping |
Whether taxes are charged for shipping. Valid values: |
| timezone |
The name of the timezone the shop is in. |
| updated_at |
The date and time (ISO 8601) when the shop was last updated. |
| weight_unit |
The default unit of weight measurement for the shop. |
| zip |
The shop's zip or postal code. |
Endpoints
| fields
|
A comma-separated list of fields to include in the response. |
Retrieve the shop's configuration
GET /admin/api/2019-04/shop.json
View Response
HTTP/1.1 200 OK
{
"shop": {
"id": 690933842,
"name": "Apple Computers",
"email": "steve@apple.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": "2019-09-30T14:02:47-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": "Steve Jobs",
"money_format": "${{amount}}",
"money_with_currency_format": "${{amount}} USD",
"weight_unit": "lb",
"province_code": "CA",
"taxes_included": null,
"tax_shipping": null,
"county_taxes": true,
"plan_display_name": "Shopify Plus",
"plan_name": "enterprise",
"has_discounts": true,
"has_gift_cards": true,
"myshopify_domain": "apple.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,
"eligible_for_card_reader_giveaway": false,
"finances": true,
"primary_location_id": 905684977,
"checkout_api_supported": true,
"multi_location_enabled": false,
"setup_required": false,
"force_ssl": true,
"pre_launch_enabled": false,
"enabled_presentment_currencies": [
"USD"
]
}
}
The Shop resource is a collection of the general settings and information about the store.
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 |
The shop's street address. |
| address2 |
The the optional second line of the shop's street address. |
| checkout_api_supported |
Whether the shop is capable of accepting payments directly through the Checkout API. |
| city |
The shop's city. |
| country |
The shop's country. In most cases matches the |
| country_code |
The two-letter country code corresponding to the shop's country. |
| country_name |
The shop's normalized country name. |
| county_taxes |
Whether the shop is applying taxes on a per-county basis. Only applicable to shops based in the US. Valid values: |
| created_at |
The date and time (ISO 8601) when the shop was created. |
| customer_email |
The contact email used for communication between the shop owner and the customer. |
| currency |
The three-letter code (ISO 4217 format) for the shop's default currency. |
| domain |
The shop's domain. |
| enabled_presentment_currencies |
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 |
Whether the shop is eligible to receive a free credit card reader from Shopify. |
| eligible_for_payments |
Whether the shop is eligible to use Shopify Payments. |
The contact email used for communication between Shopify and the shop owner. |
|
|
finances
deprecated |
This field has been deprecated, and is currently unused. Hardcoded to |
| force_ssl |
Whether the shop forces requests made to its resources to be made over SSL using the HTTPS protocol. Valid values: |
| google_apps_domain |
The GSuite URL for the store, if applicable. |
| 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: |
| has_discounts |
Whether any active discounts exist for the shop. |
| has_gift_cards |
Whether any active gift cards exist for the shop. |
| has_storefront |
Whether the shop has an online storefront. |
| iana_timezone |
The name of the timezone assigned by the IANA. |
| id |
The ID for the shop. A 64-bit unsigned integer. |
| latitude |
The latitude of the shop's location. |
| longitude |
The longitude of the shop's location. |
| money_format |
A string representing the way currency is formatted when the currency isn't specified. |
| 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 |
A string representing the way currency is formatted when the currency is specified. |
| money_with_currency_in_emails_format |
A string representing the way currency is formatted in email notifications when the currency is specified. |
| multi_location_enabled |
Whether the shop has enabled multiple locations. |
| myshopify_domain |
The shop's myshopify.com domain. |
| name |
The name of the shop. |
| password_enabled |
Whether the password protection page is enabled on the online storefront. |
| phone |
The contact phone number for the shop. |
| plan_display_name |
The display name of the Shopify plan the shop is on. |
| pre_launch_enabled |
Whether the pre-launch page is enabled on the online storefront. |
| plan_name |
The name of the Shopify plan the shop is on. |
| primary_locale |
The shop's primary locale, as configured in the language settings of the shop's theme. |
|
primary_location_id
deprecated |
Formerly used for the ID of the shipping origin location (read only). Use the Location resource instead. |
| province |
The shop's normalized province or state name. |
| province_code |
The two-letter code for the shop's province or state. |
| requires_extra_payments_agreement |
Whether the shop requires an extra Shopify Payments agreement. |
| setup_required |
Whether the shop has any outstanding setup steps or not. |
| shop_owner |
The username of the shop owner. |
| source |
The handle of the partner account that referred the merchant to Shopify, if applicable. |
| taxes_included |
Whether applicable taxes are included in product prices. Valid values: |
| tax_shipping |
Whether taxes are charged for shipping. Valid values: |
| timezone |
The name of the timezone the shop is in. |
| updated_at |
The date and time (ISO 8601) when the shop was last updated. |
| weight_unit |
The default unit of weight measurement for the shop. |
| zip |
The shop's zip or postal code. |
Endpoints
| fields
|
A comma-separated list of fields to include in the response. |
Retrieve the shop's configuration
GET /admin/api/2019-07/shop.json
View Response
HTTP/1.1 200 OK
{
"shop": {
"id": 690933842,
"name": "Apple Computers",
"email": "steve@apple.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": "2019-09-30T14:02:47-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": "Steve Jobs",
"money_format": "${{amount}}",
"money_with_currency_format": "${{amount}} USD",
"weight_unit": "lb",
"province_code": "CA",
"taxes_included": null,
"tax_shipping": null,
"county_taxes": true,
"plan_display_name": "Shopify Plus",
"plan_name": "enterprise",
"has_discounts": true,
"has_gift_cards": true,
"myshopify_domain": "apple.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,
"eligible_for_card_reader_giveaway": false,
"finances": true,
"primary_location_id": 905684977,
"checkout_api_supported": true,
"multi_location_enabled": false,
"setup_required": false,
"force_ssl": true,
"pre_launch_enabled": false,
"enabled_presentment_currencies": [
"USD"
]
}
}
The Shop resource is a collection of the general settings and information about the store.
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 |
The shop's street address. |
| address2 |
The the optional second line of the shop's street address. |
| checkout_api_supported |
Whether the shop is capable of accepting payments directly through the Checkout API. |
| city |
The shop's city. |
| country |
The shop's country. In most cases matches the |
| country_code |
The two-letter country code corresponding to the shop's country. |
| country_name |
The shop's normalized country name. |
| county_taxes |
Whether the shop is applying taxes on a per-county basis. Only applicable to shops based in the US. Valid values: |
| created_at |
The date and time (ISO 8601) when the shop was created. |
| customer_email |
The contact email used for communication between the shop owner and the customer. |
| currency |
The three-letter code (ISO 4217 format) for the shop's default currency. |
| domain |
The shop's domain. |
| enabled_presentment_currencies |
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 |
Whether the shop is eligible to receive a free credit card reader from Shopify. |
| eligible_for_payments |
Whether the shop is eligible to use Shopify Payments. |
The contact email used for communication between Shopify and the shop owner. |
|
|
finances
deprecated |
This field has been deprecated, and is currently unused. Hardcoded to |
| force_ssl |
Whether the shop forces requests made to its resources to be made over SSL using the HTTPS protocol. Valid values: |
| google_apps_domain |
The GSuite URL for the store, if applicable. |
| 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: |
| has_discounts |
Whether any active discounts exist for the shop. |
| has_gift_cards |
Whether any active gift cards exist for the shop. |
| has_storefront |
Whether the shop has an online storefront. |
| iana_timezone |
The name of the timezone assigned by the IANA. |
| id |
The ID for the shop. A 64-bit unsigned integer. |
| latitude |
The latitude of the shop's location. |
| longitude |
The longitude of the shop's location. |
| money_format |
A string representing the way currency is formatted when the currency isn't specified. |
| 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 |
A string representing the way currency is formatted when the currency is specified. |
| money_with_currency_in_emails_format |
A string representing the way currency is formatted in email notifications when the currency is specified. |
| multi_location_enabled |
Whether the shop has enabled multiple locations. |
| myshopify_domain |
The shop's myshopify.com domain. |
| name |
The name of the shop. |
| password_enabled |
Whether the password protection page is enabled on the online storefront. |
| phone |
The contact phone number for the shop. |
| plan_display_name |
The display name of the Shopify plan the shop is on. |
| pre_launch_enabled |
Whether the pre-launch page is enabled on the online storefront. |
| plan_name |
The name of the Shopify plan the shop is on. |
| primary_locale |
The shop's primary locale, as configured in the language settings of the shop's theme. |
|
primary_location_id
deprecated |
Formerly used for the ID of the shipping origin location (read only). Use the Location resource instead. |
| province |
The shop's normalized province or state name. |
| province_code |
The two-letter code for the shop's province or state. |
| requires_extra_payments_agreement |
Whether the shop requires an extra Shopify Payments agreement. |
| setup_required |
Whether the shop has any outstanding setup steps or not. |
| shop_owner |
The username of the shop owner. |
| source |
The handle of the partner account that referred the merchant to Shopify, if applicable. |
| taxes_included |
Whether applicable taxes are included in product prices. Valid values: |
| tax_shipping |
Whether taxes are charged for shipping. Valid values: |
| timezone |
The name of the timezone the shop is in. |
| updated_at |
The date and time (ISO 8601) when the shop was last updated. |
| weight_unit |
The default unit of weight measurement for the shop. |
| zip |
The shop's zip or postal code. |
Endpoints
| fields
|
A comma-separated list of fields to include in the response. |
Retrieve the shop's configuration
GET /admin/api/2019-10/shop.json
View Response
HTTP/1.1 200 OK
{
"shop": {
"id": 690933842,
"name": "Apple Computers",
"email": "steve@apple.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": "2019-09-30T14:02:47-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": "Steve Jobs",
"money_format": "${{amount}}",
"money_with_currency_format": "${{amount}} USD",
"weight_unit": "lb",
"province_code": "CA",
"taxes_included": null,
"tax_shipping": null,
"county_taxes": true,
"plan_display_name": "Shopify Plus",
"plan_name": "enterprise",
"has_discounts": true,
"has_gift_cards": true,
"myshopify_domain": "apple.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,
"eligible_for_card_reader_giveaway": false,
"finances": true,
"primary_location_id": 905684977,
"checkout_api_supported": true,
"multi_location_enabled": false,
"setup_required": false,
"force_ssl": true,
"pre_launch_enabled": false,
"enabled_presentment_currencies": [
"USD"
]
}
}