GitHub

ShopifyShop

Type

import { ShopifyShop } from '@daffodil/driver/shopify'

The central hub for store-wide settings and information accessible through the Storefront API. Provides the shop's name, description, and branding configuration including logos and colors through the Brand object.

Access store policies such as privacy, refund, shipping, and terms of service via ShopPolicy, and the subscription policy via ShopPolicyWithDefault. PaymentSettings expose accepted card brands, supported digital wallets, and enabled presentment currencies. The object also includes the primary Domain, countries the shop ships to, ShopPayInstallmentsPricing, and SocialLoginProvider options for customer accounts.

interface ShopifyShop {
  __typename: "Shop"
  brand: ShopifyBrand
  description: string
  id: string
  metafield: ShopifyMetafield
  metafields: ShopifyMetafield[]
  moneyFormat: string
  name: string
  paymentSettings: ShopifyPaymentSettings
  primaryDomain: ShopifyDomain
  privacyPolicy: ShopifyShopPolicy
  refundPolicy: ShopifyShopPolicy
  shippingPolicy: ShopifyShopPolicy
  shipsToCountries: ShopifyCountryCode[]
  shopPayInstallmentsPricing: ShopifyShopPayInstallmentsPricing
  subscriptionPolicy: ShopifyShopPolicyWithDefault
  termsOfService: ShopifyShopPolicy
}

Properties

__typename
"Shop"
brand
ShopifyBrand

The shop's branding configuration.

description
string

A description of the shop.

id
string

A globally-unique ID.

metafield
ShopifyMetafield

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

metafields
ShopifyMetafield[]

A list of custom fields that a merchant associates with a Shopify resource.

moneyFormat
string

A string representing the way currency is formatted when the currency isn’t specified.

name
string

The shop’s name.

paymentSettings
ShopifyPaymentSettings

Settings related to payments.

primaryDomain
ShopifyDomain

The primary domain of the shop’s Online Store.

privacyPolicy
ShopifyShopPolicy

The shop’s privacy policy.

refundPolicy
ShopifyShopPolicy

The shop’s refund policy.

shippingPolicy
ShopifyShopPolicy

The shop’s shipping policy.

shipsToCountries
ShopifyCountryCode[]

Countries that the shop ships to.

shopPayInstallmentsPricing
ShopifyShopPayInstallmentsPricing

The Shop Pay Installments pricing information for the shop.

subscriptionPolicy
ShopifyShopPolicyWithDefault

The shop’s subscription policy.

termsOfService
ShopifyShopPolicy

The shop’s terms of service.