Void APIs

Email address

Password

Your store name

Skip to Content

Apps
Themes
Custom storefronts
- Apps
  GraphQL Admin API
  REST Admin API
- Themes
  Liquid
  Ajax API
- Custom storefronts
  Storefront API
- View all

Search the documentation

Press to navigate, enter to select, esc to dismiss

Log in
Sign up

Apps
Themes
Custom storefronts
APIs and references

APIs and references
- Overview
- Developer previews
- 2021-10 (Release candidate)
- 2021-07
- 2021-04
- 2021-01
- 2020-10
- 2020-07
- 2020-04
- 2020-01
- 2019-10
- 2019-07
- 2019-04

- Overview
- Getting started
- - Overview
  - - Overview
    - QueryRoot
    - Actor
    - ApiVersion
    - App
    - AppPricingInterval
    - Conversation
    - ConversationStatus
    - Currency
    - MerchantUser
    - Money
    - Node
    - Organization
    - Shop
    - ShopifyEmployee
    - TeamMember
    - Theme
  - - Overview
    - deprecated
    - include
    - skip
  - - Overview
    - Unions
    - MessageSender
    - Objects
    - Job
    - JobRequirement
    - Message
    - Service
    - Enums
    - JobStatus
    - MessageSentVia
  - Scalars
  - - Overview
    - Objects
    - AppCredit
    - AppOneTimeSale
    - AppPurchaseOneTime
    - AppSaleAdjustment
    - AppSaleCredit
    - AppSubscriptionSale
    - AppUsageRecord
    - AppUsageSale
    - LegacyTransaction
    - ReferralAdjustment
    - ReferralTransaction
    - ServiceSale
    - ServiceSaleAdjustment
    - TaxTransaction
    - ThemeSale
    - ThemeSaleAdjustment
    - Interfaces
    - AppCharge
    - AppCreditEvent
    - AppPurchaseOneTimeEvent
    - AppSubscriptionEvent
    - AppUsageRecordEvent
    - Transaction
    - Enums
    - ReferralCategory
    - TaxTransactionType
    - TransactionType
- Overview
- Reference

- Overview
- - Overview
  - address
  - all_country_option_tags
  - article
  - block
  - blog
  - cart
  - checkout
  - collection
  - color
  - comment
  - country
  - country_option_tags
  - currency
  - current_page
  - current_tags
  - customer
  - customer_address
  - date
  - discount_allocation
  - discount_application
  - external_video
  - filter
  - filter_value
  - font
  - forloop
  - form
  - fulfillment
  - generic_file
  - gift_card
  - group
  - handle
  - image
  - line_item
  - link
  - linklist
  - localization
  - location
  - measurement
  - media
  - metafield
  - model
  - model_source
  - order
  - page
  - page_description
  - page_image
  - page_title
  - paginate
  - part
  - payment_terms
  - policy
  - predictive_search
  - product
  - product_option
  - rating
  - recommendations
  - request
  - robots
  - routes
  - rule
  - script
  - search
  - section
  - selling_plan
  - selling_plan_allocation
  - selling_plan_group
  - shipping_method
  - shop
  - shop_locale
  - sitemap
  - store_availability
  - tablerow
  - tax_line
  - template
  - theme
  - transaction
  - unit_price_measurement
  - user_agent
  - variant
  - video
  - video_source
  - Deprecated object properties
- Overview
Section Rendering API
Customer Privacy API

- Overview
- Utilities
- - Overview
  - Badge
  - Banner
  - Button
  - Card
  - CardSection
  - Checkbox
  - Icon
  - Link
  - Modal
  - OptionList
  - Pressable
  - Radio
  - ResourceItem
  - ResourceList
  - Select
  - Spinner
  - Stack
  - StackItem
  - Text
  - TextField
  - Thumbnail
- Overview
- - Overview
  - Extension points API
  - - Overview
    - Banner
    - BlockStack
    - Bookend
    - Button
    - ButtonGroup
    - CalloutBanner
    - Checkbox
    - Form
    - FormLayout
    - Heading
    - HeadingGroup
    - HiddenForAccessibility
    - Image
    - InlineStack
    - Layout
    - Link
    - Radio
    - Select
    - Separator
    - Spinner
    - Text
    - TextBlock
    - TextContainer
    - TextField
    - Tiles
    - View
    - VisuallyHidden
  - JWT specification
- Payment methods API
- Shipping methods API

Log in
Sign up

Opens in a new windowOpens an external siteOpens an external site in a new window

APIs and references
- Overview
- Developer previews
- 2021-10 (Release candidate)
- 2021-07
- 2021-04
- 2021-01
- 2020-10
- 2020-07
- 2020-04
- 2020-01
- 2019-10
- 2019-07
- 2019-04

- Overview
- Getting started
- - Overview
  - - Overview
    - QueryRoot
    - Actor
    - ApiVersion
    - App
    - AppPricingInterval
    - Conversation
    - ConversationStatus
    - Currency
    - MerchantUser
    - Money
    - Node
    - Organization
    - Shop
    - ShopifyEmployee
    - TeamMember
    - Theme
  - - Overview
    - deprecated
    - include
    - skip
  - - Overview
    - Unions
    - MessageSender
    - Objects
    - Job
    - JobRequirement
    - Message
    - Service
    - Enums
    - JobStatus
    - MessageSentVia
  - Scalars
  - - Overview
    - Objects
    - AppCredit
    - AppOneTimeSale
    - AppPurchaseOneTime
    - AppSaleAdjustment
    - AppSaleCredit
    - AppSubscriptionSale
    - AppUsageRecord
    - AppUsageSale
    - LegacyTransaction
    - ReferralAdjustment
    - ReferralTransaction
    - ServiceSale
    - ServiceSaleAdjustment
    - TaxTransaction
    - ThemeSale
    - ThemeSaleAdjustment
    - Interfaces
    - AppCharge
    - AppCreditEvent
    - AppPurchaseOneTimeEvent
    - AppSubscriptionEvent
    - AppUsageRecordEvent
    - Transaction
    - Enums
    - ReferralCategory
    - TaxTransactionType
    - TransactionType
- Overview
- Reference

- Overview
- - Overview
  - address
  - all_country_option_tags
  - article
  - block
  - blog
  - cart
  - checkout
  - collection
  - color
  - comment
  - country
  - country_option_tags
  - currency
  - current_page
  - current_tags
  - customer
  - customer_address
  - date
  - discount_allocation
  - discount_application
  - external_video
  - filter
  - filter_value
  - font
  - forloop
  - form
  - fulfillment
  - generic_file
  - gift_card
  - group
  - handle
  - image
  - line_item
  - link
  - linklist
  - localization
  - location
  - measurement
  - media
  - metafield
  - model
  - model_source
  - order
  - page
  - page_description
  - page_image
  - page_title
  - paginate
  - part
  - payment_terms
  - policy
  - predictive_search
  - product
  - product_option
  - rating
  - recommendations
  - request
  - robots
  - routes
  - rule
  - script
  - search
  - section
  - selling_plan
  - selling_plan_allocation
  - selling_plan_group
  - shipping_method
  - shop
  - shop_locale
  - sitemap
  - store_availability
  - tablerow
  - tax_line
  - template
  - theme
  - transaction
  - unit_price_measurement
  - user_agent
  - variant
  - video
  - video_source
  - Deprecated object properties
- Overview
Section Rendering API
Customer Privacy API

- Overview
- Utilities
- - Overview
  - Badge
  - Banner
  - Button
  - Card
  - CardSection
  - Checkbox
  - Icon
  - Link
  - Modal
  - OptionList
  - Pressable
  - Radio
  - ResourceItem
  - ResourceList
  - Select
  - Spinner
  - Stack

Objects

Mutations

Inputs

Objects

Mutations

Inputs

Enums

Unions

Objects

Mutations

Interfaces

Inputs

Enums

Objects

Mutations

Enums

Unions

Objects

Mutations

Inputs

Enums

Unions

Objects

Mutations

Inputs

Enums

Unions

Objects

Mutations

Interfaces

Inputs

Enums

Objects

Mutations

Inputs

Unions

Objects

Mutations

Interfaces

Inputs

Enums

Objects

Mutations

Inputs

Enums

Unions

Objects

Mutations

Inputs

Enums

Unions

Objects

Mutations

Interfaces

Inputs

Enums

Unions

Objects

Mutations

Inputs

Enums

Objects

Interfaces

Enums

Objects

Mutations

Inputs

Enums

Objects

Mutations

Interfaces

Inputs

Enums

ShopifyQL

Objects

Mutations

Interfaces

Inputs

Unions

Objects