@shop-on/theme-server 0.5.0 → 0.7.0

package/dist/schema.storefront.graphql

@@ -1442,10 +1442,45 @@ enum CropRegionEnum {
 A supported ISO 4217 currency code
 """
 enum CurrencyEnum {
+  """
+  Chinese yuan
+  """
+  CNY
+
+  """
+  Euro
+  """
+  EUR
+
+  """
+  Pound sterling
+  """
+  GBP
+
+  """
+  Japanese yen
+  """
+  JPY
+
+  """
+  South Korean won
+  """
+  KRW
+
   """
   Mongolian tögrög
   """
   MNT
+
+  """
+  Russian ruble
+  """
+  RUB
+
+  """
+  US dollar
+  """
+  USD
 }
 
 """
@@ -1698,6 +1733,21 @@ input DecimalFilter {
   lteq: Decimal
 }
 
+"""
+What a digital file hands the buyer.
+"""
+enum DigitalFileKind {
+  """
+  Bytes stored privately, downloaded through a short-lived link.
+  """
+  FILE
+
+  """
+  A URL the buyer is sent to instead of a file.
+  """
+  LINK
+}
+
 """
 How an applied discount was triggered.
 """
@@ -1720,6 +1770,92 @@ enum DiscountTargetTypeEnum {
   SHIPPING
 }
 
+"""
+A buyer's download of one file from their order.
+"""
+type DownloadGrant {
+  """
+  Size of the file. Null on a link.
+  """
+  byteSize: BigInt
+
+  """
+  Downloads left. Null = unlimited; 0 once revoked.
+  """
+  downloadsRemaining: Int
+
+  """
+  Name of the file. Null on a link.
+  """
+  filename: String
+  kind: DigitalFileKind!
+
+  """
+  The order it was bought on, e.g. "#1042".
+  """
+  orderName: String!
+  state: DownloadGrantState!
+  title: String!
+
+  """
+  The landing page to download from, or that says it is being prepared. Opening
+  it counts nothing; its Download button does. Null once exhausted or revoked.
+  """
+  url: String
+}
+
+"""
+Autogenerated input type of DownloadGrantConsume
+"""
+input DownloadGrantConsumeInput {
+  """
+  A unique identifier for the client performing the mutation.
+  """
+  clientMutationId: String
+  signedId: String!
+}
+
+"""
+Autogenerated return type of DownloadGrantConsume.
+"""
+type DownloadGrantConsumePayload {
+  """
+  A unique identifier for the client performing the mutation.
+  """
+  clientMutationId: String
+
+  """
+  Where to send the buyer. Short-lived for a file.
+  """
+  url: String
+  userErrors: [UserError!]!
+}
+
+"""
+Whether a download can be started now, and why not.
+"""
+enum DownloadGrantState {
+  """
+  Ready to download.
+  """
+  ACTIVE
+
+  """
+  Every allowed download has been used.
+  """
+  EXHAUSTED
+
+  """
+  The store is preparing it; the buyer gets an email once it is released.
+  """
+  HELD
+
+  """
+  The store has withdrawn it.
+  """
+  REVOKED
+}
+
 """
 Shipping address input on a draft order. All fields optional individually;
 completion requires at least address1 + country for shippable lines.
@@ -2322,6 +2458,13 @@ type LinkedMetafield {
 Click-attribution ids read from the buyer's browser. Allowlisted + shape-checked server-side.
 """
 input MarketingAttributionInput {
+  """
+  The buyer's marketing cookies as one `name=value; …` string (`_fbp`, `_fbc`,
+  `_ga`, `_ga_<stream>`, `_gcl_aw`, `_gcl_au`, `_ttp`). Parsed server-side and
+  never stored as sent; refused whole over 4KB.
+  """
+  cookies: String
+
   """
   Meta click id (`_fbc` cookie).
   """
@@ -2391,6 +2534,14 @@ enum MenuItemTypeEnum {
   PRODUCT
 }
 
+"""
+A metafield named by namespace + key.
+"""
+input MetafieldKeyInput {
+  key: String!
+  namespace: String!
+}
+
 input MetaobjectDefinitionFilter {
   """
   Exact handle match
@@ -2719,6 +2870,16 @@ type Mutation {
     input: CustomerUpdateInput!
   ): CustomerUpdatePayload
 
+  """
+  Count one download of a digital file and return the URL to fetch it from.
+  """
+  downloadGrantConsume(
+    """
+    Parameters for DownloadGrantConsume
+    """
+    input: DownloadGrantConsumeInput!
+  ): DownloadGrantConsumePayload
+
   """
   Buyer-side completion of a draft invoice into a pending-payment order.
   """
@@ -3457,6 +3618,12 @@ type Query {
   """
   districts(provinceId: ID!): [AddressDistrict!]!
 
+  """
+  The download behind an emailed link, for its landing page. Counts nothing.
+  Null on a bad signed id or one from another shop.
+  """
+  downloadGrant(signedId: String!): DownloadGrant
+
   """
   Resolve a draft order by its plaintext invoice token. Returns null on INVOICE_INVALID / INVOICE_EXPIRED / DRAFT_COMPLETED.
   """
@@ -4586,6 +4753,11 @@ type Shop implements Node {
   """
   refundPolicy: ShopPolicy
 
+  """
+  Per-shop return policy defaults. Always present — an unconfigured shop reads back the defaults.
+  """
+  returnPolicy: ShopReturnPolicy!
+
   """
   Shop-level SEO settings (homepage meta, social image, verification tokens). Null until the merchant configures it.
   """
@@ -4734,6 +4906,45 @@ type ShopArticle implements Node {
   True if status is published AND published_at is null or past.
   """
   isPublished: Boolean!
+
+  """
+  A metafield attached to this resource, looked up by namespace + key. On the
+  storefront, resolves only when the definition opts in via storefrontVisible.
+  """
+  metafield(key: String!, namespace: String!): ShopMetafield
+
+  """
+  Metafields attached to this resource. Optionally scoped by namespace, or to
+  the named namespace + key pairs. On the storefront, only definitions that opt
+  in via storefrontVisible are returned.
+  """
+  metafields(
+    """
+    Returns the elements in the list that come after the specified cursor.
+    """
+    after: String
+
+    """
+    Returns the elements in the list that come before the specified cursor.
+    """
+    before: String
+
+    """
+    Returns the first _n_ elements from the list.
+    """
+    first: Int
+
+    """
+    Only the metafields named here (namespace + key). Applied on top of the storefront visibility gate, never around it.
+    """
+    keys: [MetafieldKeyInput!]
+
+    """
+    Returns the last _n_ elements from the list.
+    """
+    last: Int
+    namespace: String
+  ): ShopMetafieldConnection!
   publishedAt: ISO8601DateTime
 
   """
@@ -4865,6 +5076,45 @@ type ShopBlog implements Node {
   handle: String!
   id: ID!
 
+  """
+  A metafield attached to this resource, looked up by namespace + key. On the
+  storefront, resolves only when the definition opts in via storefrontVisible.
+  """
+  metafield(key: String!, namespace: String!): ShopMetafield
+
+  """
+  Metafields attached to this resource. Optionally scoped by namespace, or to
+  the named namespace + key pairs. On the storefront, only definitions that opt
+  in via storefrontVisible are returned.
+  """
+  metafields(
+    """
+    Returns the elements in the list that come after the specified cursor.
+    """
+    after: String
+
+    """
+    Returns the elements in the list that come before the specified cursor.
+    """
+    before: String
+
+    """
+    Returns the first _n_ elements from the list.
+    """
+    first: Int
+
+    """
+    Only the metafields named here (namespace + key). Applied on top of the storefront visibility gate, never around it.
+    """
+    keys: [MetafieldKeyInput!]
+
+    """
+    Returns the last _n_ elements from the list.
+    """
+    last: Int
+    namespace: String
+  ): ShopMetafieldConnection!
+
   """
   Distinct article tags in this blog (public_visible on storefront), ordered alphabetically — for tag navigation.
   """
@@ -5150,7 +5400,8 @@ type ShopCheckout implements Node {
   createdAt: ISO8601DateTime!
 
   """
-  The checkout's customer. Storefront callers get null without that customer's session.
+  The checkout's customer. Null for a storefront caller without that customer's
+  session, and for a merchant caller who may not read customers.
   """
   customer: ShopCustomer
 
@@ -5173,6 +5424,12 @@ type ShopCheckout implements Node {
   discountApplications: [ShopDiscountApplication!]!
   email: String
 
+  """
+  True when a line sells a downloadable file: the download email is how the
+  buyer gets it, so a phone alone will not complete the checkout.
+  """
+  emailRequired: Boolean!
+
   """
   The normalized code the buyer most recently typed on this checkout, regardless
   of whether it ended up being applied. Use this to re-render the cart UI's code
@@ -5387,6 +5644,45 @@ type ShopCollection implements Node {
   """
   image: FileInterface
 
+  """
+  A metafield attached to this resource, looked up by namespace + key. On the
+  storefront, resolves only when the definition opts in via storefrontVisible.
+  """
+  metafield(key: String!, namespace: String!): ShopMetafield
+
+  """
+  Metafields attached to this resource. Optionally scoped by namespace, or to
+  the named namespace + key pairs. On the storefront, only definitions that opt
+  in via storefrontVisible are returned.
+  """
+  metafields(
+    """
+    Returns the elements in the list that come after the specified cursor.
+    """
+    after: String
+
+    """
+    Returns the elements in the list that come before the specified cursor.
+    """
+    before: String
+
+    """
+    Returns the first _n_ elements from the list.
+    """
+    first: Int
+
+    """
+    Only the metafields named here (namespace + key). Applied on top of the storefront visibility gate, never around it.
+    """
+    keys: [MetafieldKeyInput!]
+
+    """
+    Returns the last _n_ elements from the list.
+    """
+    last: Int
+    namespace: String
+  ): ShopMetafieldConnection!
+
   """
   Min/max default-variant price across the unfiltered collection listing, for
   seeding the price-filter slider bounds. Unfiltered so the bounds stay stable
@@ -6892,6 +7188,14 @@ type ShopOrder implements Node {
   Total line-item discount allocated at completion.
   """
   discountAmount: Money!
+
+  """
+  True while the downloads are not ready yet: the order is paid and they are
+  still being issued, or the store holds one for release. Same rule as
+  `ShopOrderTrackingView.downloadsAwaitingRelease`. False to anyone but the
+  signed-in customer who placed the order.
+  """
+  downloadsAwaitingRelease: Boolean!
   email: String
   financialStatus: ShopOrderFinancialStatusEnum!
 
@@ -6904,6 +7208,13 @@ type ShopOrder implements Node {
   """
   fiscalReceipt: ShopFiscalReceipt
   fulfillmentStatus: ShopOrderFulfillmentStatusEnum!
+
+  """
+  True when a line sold a digital file and the order is paid, not cancelled and
+  not refunded in full: there are downloads to ask for. False to anyone but the
+  signed-in customer who placed the order, like the lines' `downloads`.
+  """
+  hasDownloads: Boolean!
   id: ID!
 
   """
@@ -7053,6 +7364,12 @@ type ShopOrderLineItem implements Node {
   """
   customAttributes: [CartLineAttribute!]!
 
+  """
+  The files this line bought, issued once the order was paid. Empty on a line
+  that sold none, and to anyone but the signed-in customer who placed the order.
+  """
+  downloads: [DownloadGrant!]!
+
   """
   True when this line sold a digital gift-card product (auto-issued a card once paid).
   """
@@ -7147,6 +7464,14 @@ type ShopOrderTrackingView {
   """
   deliveryKind: ShopOrderTrackingViewDeliveryKindEnum!
   deliveryOptionTitle: String
+
+  """
+  True while the downloads are not ready yet: the order is paid and they are
+  still being issued, or the store holds one for release. An all-digital order
+  reads fulfilled from completion, so show "being prepared" instead of links
+  while this is true. False on a link an embedded app minted.
+  """
+  downloadsAwaitingRelease: Boolean!
   financialStatus: ShopOrderFinancialStatusEnum!
   fulfillmentStatus: ShopOrderFulfillmentStatusEnum!
 
@@ -7216,6 +7541,12 @@ type ShopOrderTrackingViewLineItem {
   """
   customAttributes: [CartLineAttribute!]!
 
+  """
+  The files this line bought, issued once the order was paid. Empty on a line
+  that sold none, and on a link an embedded app minted.
+  """
+  downloads: [DownloadGrant!]!
+
   """
   The bundle this line is a component of; null on a plain line.
   """
@@ -7281,6 +7612,45 @@ type ShopPage implements Node {
   True if status is published AND published_at is null or past.
   """
   isPublished: Boolean!
+
+  """
+  A metafield attached to this resource, looked up by namespace + key. On the
+  storefront, resolves only when the definition opts in via storefrontVisible.
+  """
+  metafield(key: String!, namespace: String!): ShopMetafield
+
+  """
+  Metafields attached to this resource. Optionally scoped by namespace, or to
+  the named namespace + key pairs. On the storefront, only definitions that opt
+  in via storefrontVisible are returned.
+  """
+  metafields(
+    """
+    Returns the elements in the list that come after the specified cursor.
+    """
+    after: String
+
+    """
+    Returns the elements in the list that come before the specified cursor.
+    """
+    before: String
+
+    """
+    Returns the first _n_ elements from the list.
+    """
+    first: Int
+
+    """
+    Only the metafields named here (namespace + key). Applied on top of the storefront visibility gate, never around it.
+    """
+    keys: [MetafieldKeyInput!]
+
+    """
+    Returns the last _n_ elements from the list.
+    """
+    last: Int
+    namespace: String
+  ): ShopMetafieldConnection!
   publishedAt: ISO8601DateTime
 
   """
@@ -7586,6 +7956,11 @@ type ShopProduct implements Node {
   """
   featuredMedia: FileInterface
 
+  """
+  Whether the return policy marks the whole product final sale (no returns). Resolve on one product at a time.
+  """
+  finalSale: Boolean!
+
   """
   True when this is a digital gift-card product (gift-card category + every
   variant unshipped). Powers the storefront recipient form and digital fulfillment.
@@ -7626,14 +8001,15 @@ type ShopProduct implements Node {
   ): FileInterfaceConnection!
 
   """
-  A metafield attached to this product, looked up by namespace + key. On the
+  A metafield attached to this resource, looked up by namespace + key. On the
   storefront, resolves only when the definition opts in via storefrontVisible.
   """
   metafield(key: String!, namespace: String!): ShopMetafield
 
   """
-  Metafields attached to this product. Optionally scoped by namespace. On the
-  storefront, only definitions that opt in via storefrontVisible are returned.
+  Metafields attached to this resource. Optionally scoped by namespace, or to
+  the named namespace + key pairs. On the storefront, only definitions that opt
+  in via storefrontVisible are returned.
   """
   metafields(
     """
@@ -7651,6 +8027,11 @@ type ShopProduct implements Node {
     """
     first: Int
 
+    """
+    Only the metafields named here (namespace + key). Applied on top of the storefront visibility gate, never around it.
+    """
+    keys: [MetafieldKeyInput!]
+
     """
     Returns the last _n_ elements from the list.
     """
@@ -7664,12 +8045,9 @@ type ShopProduct implements Node {
   options: [ShopProductOption!]!
 
   """
-  Default variant's price
+  Lowest and highest variant price. Null only for a product with no variants.
   """
-  price(currency: CurrencyEnum = MNT): Float!
-    @deprecated(
-      reason: "Use `defaultVariant.priceV2` (returns Money for precise decimal arithmetic). The Float-typed `price` will be removed in a future release."
-    )
+  priceRange(currency: CurrencyEnum! = MNT): ShopProductPriceRange
 
   """
   Product classification (display-faithful, free text).
@@ -7873,6 +8251,21 @@ type ShopProductOptionValue implements Node {
   position: Int!
 }
 
+"""
+The lowest and highest price across a product's variants.
+"""
+type ShopProductPriceRange {
+  """
+  The highest variant price.
+  """
+  maxVariantPrice: Money!
+
+  """
+  The lowest variant price.
+  """
+  minVariantPrice: Money!
+}
+
 """
 A customer review on a product.
 """
@@ -8208,15 +8601,11 @@ type ShopProductVariant implements Node {
   On a bundle variant, the component variants one bundle contains. Empty on every other variant.
   """
   bundleItems: [ShopProductVariantBundleItem!]!
-  compareAt(currency: CurrencyEnum = MNT): Float!
-    @deprecated(
-      reason: "Use `compareAtV2` (returns Money; null when no sale price). The Float-typed `compareAt` will be removed in a future release."
-    )
 
   """
   Variant compare-at (original) price as a Money value. Null when there is no sale price.
   """
-  compareAtV2(currency: CurrencyEnum = MNT): Money
+  compareAtV2(currency: CurrencyEnum! = MNT): Money
   createdAt: ISO8601DateTime!
   currency: String!
 
@@ -8230,6 +8619,11 @@ type ShopProductVariant implements Node {
   First variant media — used as a thumbnail
   """
   featuredMedia: FileInterface
+
+  """
+  The GTIN for structured data: the one the merchant entered, else a barcode that passes the GS1 check; null otherwise.
+  """
+  gtin: String
   id: ID!
 
   """
@@ -8256,16 +8650,51 @@ type ShopProductVariant implements Node {
     """
     last: Int
   ): FileInterfaceConnection!
+
+  """
+  A metafield attached to this resource, looked up by namespace + key. On the
+  storefront, resolves only when the definition opts in via storefrontVisible.
+  """
+  metafield(key: String!, namespace: String!): ShopMetafield
+
+  """
+  Metafields attached to this resource. Optionally scoped by namespace, or to
+  the named namespace + key pairs. On the storefront, only definitions that opt
+  in via storefrontVisible are returned.
+  """
+  metafields(
+    """
+    Returns the elements in the list that come after the specified cursor.
+    """
+    after: String
+
+    """
+    Returns the elements in the list that come before the specified cursor.
+    """
+    before: String
+
+    """
+    Returns the first _n_ elements from the list.
+    """
+    first: Int
+
+    """
+    Only the metafields named here (namespace + key). Applied on top of the storefront visibility gate, never around it.
+    """
+    keys: [MetafieldKeyInput!]
+
+    """
+    Returns the last _n_ elements from the list.
+    """
+    last: Int
+    namespace: String
+  ): ShopMetafieldConnection!
   position: Int!
-  price(currency: CurrencyEnum = MNT): Float!
-    @deprecated(
-      reason: "Use `priceV2` (returns Money for precise decimal arithmetic). The Float-typed `price` will be removed in a future release."
-    )
 
   """
   Variant price as a Money value (Decimal amount + currency).
   """
-  priceV2(currency: CurrencyEnum = MNT): Money!
+  priceV2(currency: CurrencyEnum! = MNT): Money!
 
   """
   The product this variant belongs to.
@@ -8377,6 +8806,56 @@ type ShopProductVariantEdge {
   node: ShopProductVariant!
 }
 
+"""
+Per-shop return policy defaults. Advisory only — nothing here blocks a merchant-created return.
+"""
+type ShopReturnPolicy {
+  """
+  Whether the merchant has saved this policy. False means every value is a column default.
+  """
+  configured: Boolean!
+
+  """
+  Flat return-shipping amount in the shop currency. Null unless `returnShippingCost` is FLAT_RATE.
+  """
+  flatRateAmount: Money
+
+  """
+  Default restocking fee, 0..100. Null means no restocking fee is suggested.
+  """
+  restockingFeePercentage: Float
+
+  """
+  Who pays return shipping by default.
+  """
+  returnShippingCost: ShopReturnShippingCostEnum!
+
+  """
+  Days after shipment a buyer may return an item. Null means an unlimited window.
+  """
+  returnWindowDays: Int
+}
+
+"""
+Who pays to ship a return back, by default.
+"""
+enum ShopReturnShippingCostEnum {
+  """
+  The buyer arranges and pays for return shipping.
+  """
+  CUSTOMER_PROVIDED
+
+  """
+  A fixed amount is withheld; see `flatRateAmount`.
+  """
+  FLAT_RATE
+
+  """
+  The merchant covers return shipping.
+  """
+  FREE
+}
+
 """
 Per-shop SEO settings consumed by the storefront theme.
 """
@@ -9170,7 +9649,7 @@ type Theme implements Node {
   metadata: JSON!
   name: String!
   presets: [ThemePreset!]!
-  price(currency: CurrencyEnum = MNT): Float!
+  price(currency: CurrencyEnum! = MNT): Float!
   status: ThemeStatusEnum!
   updatedAt: ISO8601DateTime!
 }