Skip to Content
shopify.dev docs
  • Apps
  • Themes
  • Custom storefronts
  • Marketplaces

    • Apps

      • GraphQL Admin API
      • REST Admin API

    • Themes

      • Liquid
      • Ajax API

    • Custom storefronts

      • Storefront API
      • Hydrogen
      • View all
  • Log in
  • Sign up
shopify.dev docs
  • Apps
  • Themes
  • Custom storefronts
  • Marketplaces
  • APIs and references
      • GraphQL Admin API
      • REST Admin API
      • Liquid
      • Ajax API
      • Storefront API
      • Hydrogen
      • View all
  • Overview
    • Overview
    • Developer previews
    • 2024-01 (Release candidate)
    • 2023-10
    • 2023-07
    • 2023-04
    • 2023-01
    • Previous versions
    • Overview
    • Authentication
    • Access scopes
      • Overview
      • Getting updates
      • API health report
    • Global IDs
    • Rate limits
    • Search syntax
    • Response status codes
    • Idempotent requests
      • Exports and queries
      • Imports and mutations
      • GraphQL
      • REST
    • Overview
    • Getting started
    • GraphQL reference
    • REST reference
    • Overview
    • Reference
    • Mobile optimization
        • App setup
        • Using React
        • Overview
        • App state
        • Button
        • ButtonGroup
        • Cart
        • ContextualSaveBar
        • Error
        • Features
        • Fullscreen
        • Loading
          • Overview
          • Channel Menu
          • Navigation Menu
        • Modal
          • Overview
          • History
          • Redirect / Navigate
        • POS
        • unstable_Picker
        • ResourcePicker
        • Scanner
        • Sharing
        • TitleBar
        • Toast
      • Methods
      • Debugging
  • Remix app package
  • Partner API
  • Payments Apps API
    • Overview
        • Overview
          • Overview
            • Overview
            • Unions
            • Merchandise
            • Objects
            • Attribute
            • BuyerIdentity
            • BuyerJourney
            • Cart
            • CartCost
            • CartDeliveryGroup
            • CartDeliveryOption
            • CartLine
            • CartLineCost
            • CollectionMembership
            • Company
            • CompanyContact
            • CompanyLocation
            • Country
            • Customer
            • CustomProduct
            • DeliverableCartLine
            • GateConfiguration
            • GateSubject
            • HasTagResponse
            • Language
            • Localization
            • LocalTime
            • MailingAddress
            • Market
            • MarketRegionCountry
            • Metafield
            • MoneyV2
            • Product
            • ProductVariant
            • PurchasingCompany
            • SellingPlan
            • SellingPlanAllocation
            • SellingPlanAllocationPriceAdjustment
            • Shop
            • Interfaces
            • HasGates
            • HasMetafields
            • MarketRegion
            • Enums
            • BuyerJourneyStep
            • CountryCode
            • CurrencyCode
            • DeliveryMethod
            • LanguageCode
            • WeightUnit
          • FunctionResult
          • FunctionRunResult
          • Input
          • Scalars
        • Overview
          • Overview
            • Overview
            • Unions
            • Merchandise
            • Objects
            • Attribute
            • BuyerIdentity
            • Cart
            • CartLine
            • CartLineCost
            • CartLineInput
            • CartOperation
            • CartTransform
            • CollectionMembership
            • Company
            • CompanyContact
            • CompanyLocation
            • Country
            • Customer
            • CustomProduct
            • ExpandedItem
            • ExpandedItemFixedPricePerUnitAdjustment
            • ExpandedItemPriceAdjustment
            • ExpandedItemPriceAdjustmentValue
            • ExpandOperation
            • GateConfiguration
            • GateSubject
            • HasTagResponse
            • ImageInput
            • Language
            • Localization
            • LocalTime
            • Market
            • MarketRegionCountry
            • MergeOperation
            • Metafield
            • MoneyV2
            • PriceAdjustment
            • PriceAdjustmentValue
            • Product
            • ProductVariant
            • PurchasingCompany
            • SellingPlan
            • SellingPlanAllocation
            • SellingPlanAllocationPriceAdjustment
            • Shop
            • UpdateOperation
            • UpdateOperationFixedPricePerUnitAdjustment
            • UpdateOperationPriceAdjustment
            • UpdateOperationPriceAdjustmentValue
            • Interfaces
            • HasGates
            • HasMetafields
            • MarketRegion
            • Enums
            • CountryCode
            • CurrencyCode
            • LanguageCode
            • WeightUnit
          • FunctionResult
          • FunctionRunResult
          • Input
          • Scalars
        • Developer preview
        • Overview
          • Overview
            • Overview
            • Unions
            • Merchandise
            • Objects
            • Attribute
            • BuyerIdentity
            • Cart
            • CartCost
            • CartDeliveryGroup
            • CartDeliveryOption
            • CartLine
            • CartLineCost
            • CollectionMembership
            • Company
            • CompanyContact
            • CompanyLocation
            • Country
            • Customer
            • CustomProduct
            • DeliverableCartLine
            • DeliveryCustomization
            • GateConfiguration
            • GateSubject
            • HasTagResponse
            • HideOperation
            • Language
            • Localization
            • LocalTime
            • MailingAddress
            • Market
            • MarketRegionCountry
            • Metafield
            • MoneyV2
            • MoveOperation
            • Operation
            • Product
            • ProductVariant
            • PurchasingCompany
            • RenameOperation
            • SellingPlan
            • SellingPlanAllocation
            • SellingPlanAllocationPriceAdjustment
            • Shop
            • Interfaces
            • HasGates
            • HasMetafields
            • MarketRegion
            • Enums
            • CountryCode
            • CurrencyCode
            • DeliveryMethod
            • LanguageCode
            • WeightUnit
          • FunctionResult
          • FunctionRunResult
          • Input
          • Scalars
          • Overview
            • Overview
              • Overview
              • Unions
              • Merchandise
              • Objects
              • Attribute
              • BuyerIdentity
              • Cart
              • CartCost
              • CartDeliveryGroup
              • CartDeliveryOption
              • CartLine
              • CartLineCost
              • CollectionMembership
              • Company
              • CompanyContact
              • CompanyLocation
              • Condition
              • Country
              • Customer
              • CustomProduct
              • DeliverableCartLine
              • Discount
              • DiscountNode
              • FixedAmount
              • GateConfiguration
              • GateSubject
              • HasTagResponse
              • Language
              • Localization
              • LocalTime
              • MailingAddress
              • Market
              • MarketRegionCountry
              • Metafield
              • MoneyV2
              • OrderMinimumSubtotal
              • OrderSubtotalTarget
              • Percentage
              • Product
              • ProductMinimumQuantity
              • ProductMinimumSubtotal
              • ProductVariant
              • ProductVariantTarget
              • PurchasingCompany
              • SellingPlan
              • SellingPlanAllocation
              • SellingPlanAllocationPriceAdjustment
              • Shop
              • Target
              • Value
              • Interfaces
              • HasGates
              • HasMetafields
              • MarketRegion
              • Enums
              • CountryCode
              • CurrencyCode
              • DeliveryMethod
              • DiscountApplicationStrategy
              • LanguageCode
              • TargetType
              • WeightUnit
            • FunctionResult
            • FunctionRunResult
            • Input
            • Scalars
          • Overview
            • Overview
              • Overview
              • Unions
              • Merchandise
              • Objects
              • Attribute
              • BuyerIdentity
              • Cart
              • CartCost
              • CartDeliveryGroup
              • CartDeliveryOption
              • CartLine
              • CartLineCost
              • CollectionMembership
              • Company
              • CompanyContact
              • CompanyLocation
              • Country
              • Customer
              • CustomProduct
              • DeliverableCartLine
              • Discount
              • DiscountNode
              • FixedAmount
              • GateConfiguration
              • GateSubject
              • HasTagResponse
              • Language
              • Localization
              • LocalTime
              • MailingAddress
              • Market
              • MarketRegionCountry
              • Metafield
              • MoneyV2
              • Percentage
              • Product
              • ProductVariant
              • ProductVariantTarget
              • PurchasingCompany
              • SellingPlan
              • SellingPlanAllocation
              • SellingPlanAllocationPriceAdjustment
              • Shop
              • Target
              • Value
              • Interfaces
              • HasGates
              • HasMetafields
              • MarketRegion
              • Enums
              • CountryCode
              • CurrencyCode
              • DeliveryMethod
              • DiscountApplicationStrategy
              • LanguageCode
              • WeightUnit
            • FunctionResult
            • FunctionRunResult
            • Input
            • Scalars
          • Overview
            • Overview
              • Overview
              • Unions
              • Merchandise
              • Objects
              • Attribute
              • BuyerIdentity
              • Cart
              • CartCost
              • CartDeliveryGroup
              • CartDeliveryOption
              • CartLine
              • CartLineCost
              • CollectionMembership
              • Company
              • CompanyContact
              • CompanyLocation
              • Country
              • Customer
              • CustomProduct
              • DeliverableCartLine
              • DeliveryGroupTarget
              • DeliveryOptionTarget
              • Discount
              • DiscountNode
              • FixedAmount
              • GateConfiguration
              • GateSubject
              • HasTagResponse
              • Language
              • Localization
              • LocalTime
              • MailingAddress
              • Market
              • MarketRegionCountry
              • Metafield
              • MoneyV2
              • Percentage
              • Product
              • ProductVariant
              • PurchasingCompany
              • SellingPlan
              • SellingPlanAllocation
              • SellingPlanAllocationPriceAdjustment
              • Shop
              • Target
              • Value
              • Interfaces
              • HasGates
              • HasMetafields
              • MarketRegion
              • Enums
              • CountryCode
              • CurrencyCode
              • DeliveryMethod
              • DiscountApplicationStrategy
              • LanguageCode
              • WeightUnit
            • FunctionResult
            • FunctionRunResult
            • Input
            • Scalars
        • Overview
          • Overview
            • Overview
            • Unions
            • Merchandise
            • Objects
            • Attribute
            • BuyerIdentity
            • Cart
            • CartCost
            • CartDeliveryGroup
            • CartDeliveryOption
            • CartLine
            • CartLineCost
            • CollectionMembership
            • Company
            • CompanyContact
            • CompanyLocation
            • Country
            • Customer
            • CustomProduct
            • DeliverableCartLine
            • FulfillmentConstraintRule
            • GateConfiguration
            • GateSubject
            • HasTagResponse
            • Language
            • Localization
            • LocalTime
            • Location
            • LocationAddress
            • MailingAddress
            • Market
            • MarketRegionCountry
            • Metafield
            • MoneyV2
            • MustFulfillFrom
            • MustFulfillFromSameLocation
            • Operation
            • Product
            • ProductVariant
            • PurchasingCompany
            • SellingPlan
            • SellingPlanAllocation
            • SellingPlanAllocationPriceAdjustment
            • Shop
            • Interfaces
            • HasGates
            • HasMetafields
            • MarketRegion
            • Enums
            • CountryCode
            • CurrencyCode
            • DeliveryMethod
            • LanguageCode
            • WeightUnit
          • FunctionResult
          • FunctionRunResult
          • Input
          • Scalars
        • Overview
          • Overview
            • Unions
            • Merchandise
            • Objects
            • Attribute
            • BuyerIdentity
            • Cart
            • CartCost
            • CartDeliveryGroup
            • CartDeliveryOption
            • CartLine
            • CartLineCost
            • CollectionMembership
            • Company
            • CompanyContact
            • CompanyLocation
            • Country
            • Customer
            • CustomProduct
            • DeliverableCartLine
            • DeliveryOptionGenerator
            • FulfillmentGroup
            • GateConfiguration
            • GateSubject
            • HasTagResponse
            • Language
            • Localization
            • LocalPickupDeliveryOption
            • LocalTime
            • Location
            • LocationAddress
            • MailingAddress
            • Market
            • MarketRegionCountry
            • Metafield
            • MoneyV2
            • Operation
            • PickupLocation
            • Product
            • ProductVariant
            • PurchasingCompany
            • SellingPlan
            • SellingPlanAllocation
            • SellingPlanAllocationPriceAdjustment
            • Shop
            • Interfaces
            • HasGates
            • HasMetafields
            • MarketRegion
            • Enums
            • CountryCode
            • CurrencyCode
            • DeliveryMethod
            • LanguageCode
            • WeightUnit
          • FunctionResult
          • FunctionRunResult
          • Input
          • Scalars
        • Overview
          • Overview
            • Overview
            • Unions
            • Merchandise
            • Objects
            • Attribute
            • BuyerIdentity
            • Cart
            • CartCost
            • CartDeliveryGroup
            • CartDeliveryOption
            • CartLine
            • CartLineCost
            • CollectionMembership
            • Company
            • CompanyContact
            • CompanyLocation
            • Country
            • Customer
            • CustomProduct
            • DeliverableCartLine
            • FulfillmentGroup
            • FulfillmentGroupRankedLocations
            • GateConfiguration
            • GateSubject
            • HasTagResponse
            • Language
            • Localization
            • LocalTime
            • Location
            • LocationAddress
            • MailingAddress
            • Market
            • MarketRegionCountry
            • Metafield
            • MoneyV2
            • Operation
            • OrderRoutingLocationRule
            • Product
            • ProductVariant
            • PurchasingCompany
            • RankedLocation
            • SellingPlan
            • SellingPlanAllocation
            • SellingPlanAllocationPriceAdjustment
            • Shop
            • Interfaces
            • HasGates
            • HasMetafields
            • MarketRegion
            • Enums
            • CountryCode
            • CurrencyCode
            • DeliveryMethod
            • LanguageCode
            • WeightUnit
          • FunctionResult
          • FunctionRunResult
          • Input
          • Scalars
        • Overview
          • Overview
            • Overview
            • Unions
            • Merchandise
            • Objects
            • Attribute
            • BuyerIdentity
            • Cart
            • CartCost
            • CartDeliveryGroup
            • CartDeliveryOption
            • CartLine
            • CartLineCost
            • CollectionMembership
            • Company
            • CompanyContact
            • CompanyLocation
            • Country
            • Customer
            • CustomProduct
            • DeliverableCartLine
            • GateConfiguration
            • GateSubject
            • HasTagResponse
            • HideOperation
            • Language
            • Localization
            • LocalTime
            • MailingAddress
            • Market
            • MarketRegionCountry
            • Metafield
            • MoneyV2
            • MoveOperation
            • Operation
            • PaymentCustomization
            • PaymentCustomizationPaymentMethod
            • Product
            • ProductVariant
            • PurchasingCompany
            • RenameOperation
            • SellingPlan
            • SellingPlanAllocation
            • SellingPlanAllocationPriceAdjustment
            • Shop
            • Interfaces
            • HasGates
            • HasMetafields
            • MarketRegion
            • Enums
            • CountryCode
            • CurrencyCode
            • DeliveryMethod
            • LanguageCode
            • WeightUnit
          • FunctionResult
          • FunctionRunResult
          • Input
          • Scalars
    • Configuration
    • Error handling
    • Overview
      • ActiveDatesCard
      • AppProvider
      • CombinationCard
      • CountriesAndRatesCard
      • CustomerEligibilityCard
      • MethodCard
      • MinimumRequirementsCard
      • PurchaseTypeCard
      • SummaryCard
      • UsageLimitsCard
    • Overview
    • Reference
  • Multipass
    • Overview
    • ShopifyQL reference
    • Segment query language reference
      • Orders dataset
      • Products dataset
      • Payment attempts dataset
    • Overview
      • Connect wallet
      • Tokengate
    • Theming
    • Analytics
  • Liquid
    • Overview
      • Cart
      • Product
      • Product recommendations
      • Predictive search
  • Section Rendering API
  • Customer Privacy API
  • Storefront API
  • Customer Account API
  • Hydrogen
  • Hydrogen React
    • Overview
    • APIs
    • Components
    • Overview
    • Checkout UI
      • Overview
      • Configuration
      • Extension points API
        • Overview
        • Banner
        • BlockStack
        • Bookend
        • Button
        • ButtonGroup
        • BuyerConsent
        • CalloutBanner
        • Checkbox
        • Form
        • FormLayout
        • Heading
        • HeadingGroup
        • HiddenForAccessibility
        • Image
        • InlineStack
        • Layout
        • Link
        • Radio
        • Select
        • Separator
        • Spinner
        • Text
        • TextBlock
        • TextContainer
        • TextField
        • Tiles
        • View
        • VisuallyHidden
      • JWT specification
    • Overview
      • Overview
      • Extension Points
        • Cart
        • Connectivity
        • Device
        • Locale
        • Navigation
        • Product Search
        • Scanner
        • Session
        • Smart Grid
        • Toast
        • Badge
        • Banner
        • Button
        • CameraScanner
        • DateField
        • DatePicker
        • Dialog
        • EmailField
        • FormattedTextField
        • Icon
        • Image
        • List
        • NumberField
        • Navigator
        • PinPad
        • RadioButtonList
        • Screen
        • ScrollView
        • SearchBar
        • Section
        • SegmentedControl
        • Selectable
        • Spacing
        • Stack
        • Stepper
        • Text
        • TextField
        • TextArea
        • Tile
        • TimeField
        • TimePicker
      • Versions
    • Cart extension reference
    • Product recommendations reference
    • Overview
    • Web Pixels API
    • Overview
    • Components
    • Endpoints
    • Statuses
    • Overview
      • Overview
      • LayoutApi
      • LocaleApi
      • SessionTokenApi
      • ToastApi
      • Overview
      • Badge
      • Banner
      • BlockStack
      • Button
      • Card
      • CardSection
      • Checkbox
      • Heading
      • Icon
      • InlineStack
      • Link
      • Modal
      • OptionList
      • Pressable
      • Radio
      • ResourceItem
      • ResourceList
      • Select
      • Spinner
      • StackItem
      • Text
      • TextBlock
      • TextField
      • Thumbnail
  • Log in
  • Sign up
Opens in a new windowOpens an external siteOpens an external site in a new window
APIs and references
  • Overview
    • Overview
    • Developer previews
    • 2024-01 (Release candidate)
    • 2023-10
    • 2023-07
    • 2023-04
    • 2023-01
    • Previous versions
    • Overview
    • Authentication
    • Access scopes
      • Overview
      • Getting updates
      • API health report
    • Global IDs
    • Rate limits
    • Search syntax
    • Response status codes
    • Idempotent requests
      • Exports and queries
      • Imports and mutations
      • GraphQL
      • REST
    • Overview
    • Getting started
    • GraphQL reference
    • REST reference
    • Overview
    • Reference
    • Mobile optimization
        • App setup
        • Using React
        • Overview
        • App state
        • Button
        • ButtonGroup
        • Cart
        • ContextualSaveBar
        • Error
        • Features
        • Fullscreen
        • Loading
          • Overview
          • Channel Menu
          • Navigation Menu
        • Modal
          • Overview
          • History
          • Redirect / Navigate
        • POS
        • unstable_Picker
        • ResourcePicker
        • Scanner
        • Sharing
        • TitleBar
        • Toast
      • Methods
      • Debugging
  • Remix app package
  • Partner API
  • Payments Apps API
    • Overview
        • Overview
          • Overview
            • Overview
            • Unions
            • Merchandise
            • Objects
            • Attribute
            • BuyerIdentity
            • BuyerJourney
            • Cart
            • CartCost
            • CartDeliveryGroup
            • CartDeliveryOption
            • CartLine
            • CartLineCost
            • CollectionMembership
            • Company
            • CompanyContact
            • CompanyLocation
            • Country
            • Customer
            • CustomProduct
            • DeliverableCartLine
            • GateConfiguration
            • GateSubject
            • HasTagResponse
            • Language
            • Localization
            • LocalTime
            • MailingAddress
            • Market
            • MarketRegionCountry
            • Metafield
            • MoneyV2
            • Product
            • ProductVariant
            • PurchasingCompany
            • SellingPlan
            • SellingPlanAllocation
            • SellingPlanAllocationPriceAdjustment
            • Shop
            • Interfaces
            • HasGates
            • HasMetafields
            • MarketRegion
            • Enums
            • BuyerJourneyStep
            • CountryCode
            • CurrencyCode
            • DeliveryMethod
            • LanguageCode
            • WeightUnit
          • FunctionResult
          • FunctionRunResult
          • Input
          • Scalars
        • Overview
          • Overview
            • Overview
            • Unions
            • Merchandise
            • Objects
            • Attribute
            • BuyerIdentity
            • Cart
            • CartLine
            • CartLineCost
            • CartLineInput
            • CartOperation
            • CartTransform
            • CollectionMembership
            • Company
            • CompanyContact
            • CompanyLocation
            • Country
            • Customer
            • CustomProduct
            • ExpandedItem
            • ExpandedItemFixedPricePerUnitAdjustment
            • ExpandedItemPriceAdjustment
            • ExpandedItemPriceAdjustmentValue
            • ExpandOperation
            • GateConfiguration
            • GateSubject
            • HasTagResponse
            • ImageInput
            • Language
            • Localization
            • LocalTime
            • Market
            • MarketRegionCountry
            • MergeOperation
            • Metafield
            • MoneyV2
            • PriceAdjustment
            • PriceAdjustmentValue
            • Product
            • ProductVariant
            • PurchasingCompany
            • SellingPlan
            • SellingPlanAllocation
            • SellingPlanAllocationPriceAdjustment
            • Shop
            • UpdateOperation
            • UpdateOperationFixedPricePerUnitAdjustment
            • UpdateOperationPriceAdjustment
            • UpdateOperationPriceAdjustmentValue
            • Interfaces
            • HasGates
            • HasMetafields
            • MarketRegion
            • Enums
            • CountryCode
            • CurrencyCode
            • LanguageCode
            • WeightUnit
          • FunctionResult
          • FunctionRunResult
          • Input
          • Scalars
        • Developer preview
        • Overview
          • Overview
            • Overview
            • Unions
            • Merchandise
            • Objects
            • Attribute
            • BuyerIdentity
            • Cart
            • CartCost
            • CartDeliveryGroup
            • CartDeliveryOption
            • CartLine
            • CartLineCost
            • CollectionMembership
            • Company
            • CompanyContact
            • CompanyLocation
            • Country
            • Customer
            • CustomProduct
            • DeliverableCartLine
            • DeliveryCustomization
            • GateConfiguration
            • GateSubject
            • HasTagResponse
            • HideOperation
            • Language
            • Localization
            • LocalTime
            • MailingAddress
            • Market
            • MarketRegionCountry
            • Metafield
            • MoneyV2
            • MoveOperation
            • Operation
            • Product
            • ProductVariant
            • PurchasingCompany
            • RenameOperation
            • SellingPlan
            • SellingPlanAllocation
            • SellingPlanAllocationPriceAdjustment
            • Shop
            • Interfaces
            • HasGates
            • HasMetafields
            • MarketRegion
            • Enums
            • CountryCode
            • CurrencyCode
            • DeliveryMethod
            • LanguageCode
            • WeightUnit
          • FunctionResult
          • FunctionRunResult
          • Input
          • Scalars
          • Overview
            • Overview
              • Overview
              • Unions
              • Merchandise
              • Objects
              • Attribute
              • BuyerIdentity
              • Cart
              • CartCost
              • CartDeliveryGroup
              • CartDeliveryOption
              • CartLine
              • CartLineCost
              • CollectionMembership
              • Company
              • CompanyContact
              • CompanyLocation
              • Condition
              • Country
              • Customer
              • CustomProduct
              • DeliverableCartLine
              • Discount
              • DiscountNode
              • FixedAmount
              • GateConfiguration
              • GateSubject
              • HasTagResponse
              • Language
              • Localization
              • LocalTime
              • MailingAddress
              • Market
              • MarketRegionCountry
              • Metafield
              • MoneyV2
              • OrderMinimumSubtotal
              • OrderSubtotalTarget
              • Percentage
              • Product
              • ProductMinimumQuantity
              • ProductMinimumSubtotal
              • ProductVariant
              • ProductVariantTarget
              • PurchasingCompany
              • SellingPlan
              • SellingPlanAllocation
              • SellingPlanAllocationPriceAdjustment
              • Shop
              • Target
              • Value
              • Interfaces
              • HasGates
              • HasMetafields
              • MarketRegion
              • Enums
              • CountryCode
              • CurrencyCode
              • DeliveryMethod
              • DiscountApplicationStrategy
              • LanguageCode
              • TargetType
              • WeightUnit
            • FunctionResult
            • FunctionRunResult
            • Input
            • Scalars
          • Overview
            • Overview
              • Overview
              • Unions
              • Merchandise
              • Objects
              • Attribute
              • BuyerIdentity
              • Cart
              • CartCost
              • CartDeliveryGroup
              • CartDeliveryOption
              • CartLine
              • CartLineCost
              • CollectionMembership
              • Company
              • CompanyContact
              • CompanyLocation
              • Country
              • Customer
              • CustomProduct
              • DeliverableCartLine
              • Discount
              • DiscountNode
              • FixedAmount
              • GateConfiguration
              • GateSubject
              • HasTagResponse
              • Language
              • Localization
              • LocalTime
              • MailingAddress
              • Market
              • MarketRegionCountry
              • Metafield
              • MoneyV2
              • Percentage
              • Product
              • ProductVariant
              • ProductVariantTarget
              • PurchasingCompany
              • SellingPlan
              • SellingPlanAllocation
              • SellingPlanAllocationPriceAdjustment
              • Shop
              • Target
              • Value
              • Interfaces
              • HasGates
              • HasMetafields
              • MarketRegion
              • Enums
              • CountryCode
              • CurrencyCode
              • DeliveryMethod
              • DiscountApplicationStrategy
              • LanguageCode
              • WeightUnit
            • FunctionResult
            • FunctionRunResult
            • Input
            • Scalars
          • Overview
            • Overview
              • Overview
              • Unions
              • Merchandise
              • Objects
              • Attribute
              • BuyerIdentity
              • Cart
              • CartCost
              • CartDeliveryGroup
              • CartDeliveryOption
              • CartLine
              • CartLineCost
              • CollectionMembership
              • Company
              • CompanyContact
              • CompanyLocation
              • Country
              • Customer
              • CustomProduct
              • DeliverableCartLine
              • DeliveryGroupTarget
              • DeliveryOptionTarget
              • Discount
              • DiscountNode
              • FixedAmount
              • GateConfiguration
              • GateSubject
              • HasTagResponse
              • Language
              • Localization
              • LocalTime
              • MailingAddress
              • Market
              • MarketRegionCountry
              • Metafield
              • MoneyV2
              • Percentage
              • Product
              • ProductVariant
              • PurchasingCompany
              • SellingPlan
              • SellingPlanAllocation
              • SellingPlanAllocationPriceAdjustment
              • Shop
              • Target
              • Value
              • Interfaces
              • HasGates
              • HasMetafields
              • MarketRegion
              • Enums
              • CountryCode
              • CurrencyCode
              • DeliveryMethod
              • DiscountApplicationStrategy
              • LanguageCode
              • WeightUnit
            • FunctionResult
            • FunctionRunResult
            • Input
            • Scalars
        • Overview
          • Overview
            • Overview
            • Unions
            • Merchandise
            • Objects
            • Attribute
            • BuyerIdentity
            • Cart
            • CartCost
            • CartDeliveryGroup
            • CartDeliveryOption
            • CartLine
            • CartLineCost
            • CollectionMembership
            • Company
            • CompanyContact
            • CompanyLocation
            • Country
            • Customer
            • CustomProduct
            • DeliverableCartLine
            • FulfillmentConstraintRule
            • GateConfiguration
            • GateSubject
            • HasTagResponse
            • Language
            • Localization
            • LocalTime
            • Location
            • LocationAddress
            • MailingAddress
            • Market
            • MarketRegionCountry
            • Metafield
            • MoneyV2
            • MustFulfillFrom
            • MustFulfillFromSameLocation
            • Operation
            • Product
            • ProductVariant
            • PurchasingCompany
            • SellingPlan
            • SellingPlanAllocation
            • SellingPlanAllocationPriceAdjustment
            • Shop
            • Interfaces
            • HasGates
            • HasMetafields
            • MarketRegion
            • Enums
            • CountryCode
            • CurrencyCode
            • DeliveryMethod
            • LanguageCode
            • WeightUnit
          • FunctionResult
          • FunctionRunResult
          • Input
          • Scalars
        • Overview
          • Overview
            • Unions
            • Merchandise
            • Objects
            • Attribute
            • BuyerIdentity
            • Cart
            • CartCost
            • CartDeliveryGroup
            • CartDeliveryOption
            • CartLine
            • CartLineCost
            • CollectionMembership
            • Company
            • CompanyContact
            • CompanyLocation
            • Country
            • Customer
            • CustomProduct
            • DeliverableCartLine
            • DeliveryOptionGenerator
            • FulfillmentGroup
            • GateConfiguration
            • GateSubject
            • HasTagResponse
            • Language
            • Localization
            • LocalPickupDeliveryOption
            • LocalTime
            • Location
            • LocationAddress
            • MailingAddress
            • Market
            • MarketRegionCountry
            • Metafield
            • MoneyV2
            • Operation
            • PickupLocation
            • Product
            • ProductVariant
            • PurchasingCompany
            • SellingPlan
            • SellingPlanAllocation
            • SellingPlanAllocationPriceAdjustment
            • Shop
            • Interfaces
            • HasGates
            • HasMetafields
            • MarketRegion
            • Enums
            • CountryCode
            • CurrencyCode
            • DeliveryMethod
            • LanguageCode
            • WeightUnit
          • FunctionResult
          • FunctionRunResult
          • Input
          • Scalars
        • Overview
          • Overview
            • Overview
            • Unions
            • Merchandise
            • Objects
            • Attribute
            • BuyerIdentity
            • Cart
            • CartCost
            • CartDeliveryGroup
            • CartDeliveryOption
            • CartLine
            • CartLineCost
            • CollectionMembership
            • Company
            • CompanyContact
            • CompanyLocation
            • Country
            • Customer
            • CustomProduct
            • DeliverableCartLine
            • FulfillmentGroup
            • FulfillmentGroupRankedLocations
            • GateConfiguration
            • GateSubject
            • HasTagResponse
            • Language
            • Localization
            • LocalTime
            • Location
            • LocationAddress
            • MailingAddress
            • Market
            • MarketRegionCountry
            • Metafield
            • MoneyV2
            • Operation
            • OrderRoutingLocationRule
            • Product
            • ProductVariant
            • PurchasingCompany
            • RankedLocation
            • SellingPlan
            • SellingPlanAllocation
            • SellingPlanAllocationPriceAdjustment
            • Shop
            • Interfaces
            • HasGates
            • HasMetafields
            • MarketRegion
            • Enums
            • CountryCode
            • CurrencyCode
            • DeliveryMethod
            • LanguageCode
            • WeightUnit
          • FunctionResult
          • FunctionRunResult
          • Input
          • Scalars
        • Overview
          • Overview
            • Overview
            • Unions
            • Merchandise
            • Objects
            • Attribute
            • BuyerIdentity
            • Cart
            • CartCost
            • CartDeliveryGroup
            • CartDeliveryOption
            • CartLine
            • CartLineCost
            • CollectionMembership
            • Company
            • CompanyContact
            • CompanyLocation
            • Country
            • Customer
            • CustomProduct
            • DeliverableCartLine
            • GateConfiguration
            • GateSubject
            • HasTagResponse
            • HideOperation
            • Language
            • Localization
            • LocalTime
            • MailingAddress
            • Market
            • MarketRegionCountry
            • Metafield
            • MoneyV2
            • MoveOperation
            • Operation
            • PaymentCustomization
            • PaymentCustomizationPaymentMethod
            • Product
            • ProductVariant
            • PurchasingCompany
            • RenameOperation
            • SellingPlan
            • SellingPlanAllocation
            • SellingPlanAllocationPriceAdjustment
            • Shop
            • Interfaces
            • HasGates
            • HasMetafields
            • MarketRegion
            • Enums
            • CountryCode
            • CurrencyCode
            • DeliveryMethod
            • LanguageCode
            • WeightUnit
          • FunctionResult
          • FunctionRunResult
          • Input
          • Scalars
    • Configuration
    • Error handling
    • Overview
      • ActiveDatesCard
      • AppProvider
      • CombinationCard
      • CountriesAndRatesCard
      • CustomerEligibilityCard
      • MethodCard
      • MinimumRequirementsCard
      • PurchaseTypeCard
      • SummaryCard
      • UsageLimitsCard
    • Overview
    • Reference
  • Multipass
    • Overview
    • ShopifyQL reference
    • Segment query language reference
      • Orders dataset
      • Products dataset
      • Payment attempts dataset
    • Overview
      • Connect wallet
      • Tokengate
    • Theming
    • Analytics
  • Liquid
    • Overview
      • Cart
      • Product
      • Product recommendations
      • Predictive search
  • Section Rendering API
  • Customer Privacy API
  • Storefront API
  • Customer Account API
  • Hydrogen
  • Hydrogen React
    • Overview
    • APIs
    • Components
    • Overview
    • Checkout UI
      • Overview
      • Configuration
      • Extension points API
        • Overview
        • Banner
        • BlockStack
        • Bookend
        • Button
        • ButtonGroup
        • BuyerConsent
        • CalloutBanner
        • Checkbox
        • Form
        • FormLayout
        • Heading
        • HeadingGroup
        • HiddenForAccessibility
        • Image
        • InlineStack
        • Layout
        • Link
        • Radio
        • Select
        • Separator
        • Spinner
        • Text
        • TextBlock
        • TextContainer
        • TextField
        • Tiles
        • View
        • VisuallyHidden
      • JWT specification
    • Overview
      • Overview
      • Extension Points
        • Cart
        • Connectivity
        • Device
        • Locale
        • Navigation
        • Product Search
        • Scanner
        • Session
        • Smart Grid
        • Toast
        • Badge
        • Banner
        • Button
        • CameraScanner
        • DateField
        • DatePicker
        • Dialog
        • EmailField
        • FormattedTextField
        • Icon
        • Image
        • List
        • NumberField
        • Navigator
        • PinPad
        • RadioButtonList
        • Screen
        • ScrollView
        • SearchBar
        • Section
        • SegmentedControl
        • Selectable
        • Spacing
        • Stack
        • Stepper
        • Text
        • TextField
        • TextArea
        • Tile
        • TimeField
        • TimePicker
      • Versions
    • Cart extension reference
    • Product recommendations reference
    • Overview
    • Web Pixels API
    • Overview
    • Components
    • Endpoints
    • Statuses
    • Overview
      • Overview
      • LayoutApi
      • LocaleApi
      • SessionTokenApi
      • ToastApi
      • Overview
      • Badge
      • Banner
      • BlockStack
      • Button
      • Card
      • CardSection
      • Checkbox
      • Heading
      • Icon
      • InlineStack
      • Link
      • Modal
      • OptionList
      • Pressable
      • Radio
      • ResourceItem
      • ResourceList
      • Select
      • Spinner
      • StackItem
      • Text
      • TextBlock
      • TextField
      • Thumbnail

Country object

Unstable
2024-01 Release candidate
2023-10 Latest
2023-07
2023-04
2023-01

A country.

On this page

  • Fields
  • Types that return Country

Fields

  • isoCode (CountryCode!)

    The ISO code of the country.

Types that return Country

  • Localization.country

Updates & News

  • Developer changelog
  • Partner blog
  • Engineering blog
  • UX blog

Community

  • Developer forum
  • Discord
  • Twitter
  • YouTube

Events

  • Shopify Unite
  • Events

Legal

  • Terms of Service
  • API Terms of Service
  • Privacy policy

Subscribe to receive updates from Shopify

Subscribe to receive updates from Shopify

Thanks! We’ll be in touch.

  • About Shopify
  • Shopify Plus
  • Careers
  • Investors
  • Press and Media
Opens in a new window

Shopify uses cookies to provide necessary site functionality and improve your experience. By using our website, you agree to our privacy policy and our cookie policy .