Skip to main content

Apps
Storefronts

GraphQL Admin API

Choose a version:

2025-07latest

Overview
Client libraries
Authentication
Endpoints and queries
Rate limits
Status and error codes

Choose a version:

2025-07latest

Anchor to Boolean

Boolean

scalar

Represents true or false values.

Map

Fields with this scalar

AbandonedCheckout.taxesIncluded
Abandonment.customerHasNoDraftOrderSinceAbandonment
Abandonment.customerHasNoOrderSinceAbandonment
Abandonment.inventoryAvailable
Abandonment.isFromCustomStorefront
Abandonment.isFromOnlineStore
Abandonment.isFromShopApp
Abandonment.isFromShopPay
Abandonment.isMostSignificantAbandonment
AllDiscountItems.allItems
AndroidApplication.appLinksEnabled
ApiVersion.supported
App.embedded
App.isPostPurchaseAppInUse
App.previouslyInstalled
App.published
App.shopifyDeveloped
AppCredit.test
AppPurchaseOneTime.test
AppRevenueAttributionRecord.test
AppSubscription.test
AppleApplication.appClipsEnabled
AppleApplication.sharedWebCredentialsEnabled
AppleApplication.universalLinksEnabled
Article.isPublished
BasicEvent.attributeToApp
BasicEvent.attributeToUser
BasicEvent.criticalAlert
BasicEvent.hasAdditionalContent
BundlesFeature.eligibleForBundles

Inputs with this scalar

ArticleCreateInput.isPublished
ArticleUpdateInput.isPublished
ArticleUpdateInput.redirectNewHandle
BlogUpdateInput.redirectNewHandle
BlogUpdateInput.redirectArticles
BuyerExperienceConfigurationInput.checkoutToDraft
BuyerExperienceConfigurationInput.editableShippingAddress
CheckoutBrandingFooterInput.divided
CheckoutBrandingHeaderInput.divided
CollectionInput.redirectNewHandle
CollectionRuleSetInput.appliedDisjunctively
CompanyLocationInput.billingSameAsShipping
CompanyLocationInput.taxExempt
ConsentPolicyInput.consentRequired
ConsentPolicyInput.dataSaleOptOutRequired
CustomShippingPackageInput.default
CustomerInput.taxExempt
CustomerSegmentMembersQueryInput.reverse
CustomerSetInput.taxExempt
DeliveryCarrierServiceCreateInput.supportsServiceDiscovery
DeliveryCarrierServiceCreateInput.active
DeliveryCarrierServiceUpdateInput.supportsServiceDiscovery
DeliveryCarrierServiceUpdateInput.active
DeliveryCountryInput.restOfWorld
DeliveryCountryInput.includeAllProvinces
DeliveryCustomizationInput.enabled
DeliveryMethodDefinitionInput.active
DeliveryParticipantInput.adaptToNewServices
DeliveryParticipantServiceInput.active
DeliverySettingInput.legacyModeProfiles

Mutations with this scalar

appPurchaseOneTimeCreate
appSubscriptionCancel
appSubscriptionCreate
bulkOperationRunMutation
bulkOperationRunQuery
cartTransformCreate
catalogDelete
companyContactRevokeRoles
companyLocationTaxSettingsUpdate
customerAddressCreate
customerAddressUpdate
customerPaymentMethodPaypalBillingAgreementCreate
deliveryCustomizationActivation
deliveryProfileUpdate
deliveryPromiseProviderUpsert
fulfillmentOrderSubmitFulfillmentRequest
fulfillmentServiceCreate
fulfillmentServiceCreate
fulfillmentServiceCreate
fulfillmentServiceUpdate
fulfillmentServiceUpdate
fulfillmentServiceUpdate
fulfillmentTrackingInfoUpdate
fulfillmentTrackingInfoUpdateV2
inventoryActivate
marketingEngagementsDelete
metafieldDefinitionDelete
orderCancel
orderCancel
orderCreateMandatePayment

Queries with this scalar

abandonedCheckouts.reverse
appDiscountTypesNodes.reverse
appInstallations.reverse
articleAuthors.reverse
articles.reverse
assignedFulfillmentOrders.reverse
automaticDiscountNodes.reverse
automaticDiscountSavedSearches.reverse
automaticDiscounts.reverse
blogs.reverse
carrierServices.reverse
cartTransforms.reverse
cashTrackingSessions.reverse
catalogs.reverse
channels.reverse
checkoutProfiles.reverse
codeDiscountNodes.reverse
codeDiscountSavedSearches.reverse
collectionSavedSearches.reverse
collections.reverse
comments.reverse
companies.reverse
companyLocations.reverse
consentPolicy.consentRequired
consentPolicy.dataSaleOptOutRequired
customerAccountPages.reverse
customerPaymentMethod.showRevoked
customerSavedSearches.reverse
customerSegmentMembers.reverse
customers.reverse

Arguments with this scalar

AbandonedCheckout.lineItems(reverse)
AbandonedCheckoutLineItem.discountAllocations(reverse)
Abandonment.productsAddedToCart(reverse)
Abandonment.productsViewed(reverse)
AppCatalog.apps(reverse)
AppInstallation.allSubscriptions(reverse)
AppInstallation.credits(reverse)
AppInstallation.metafields(reverse)
AppInstallation.oneTimePurchases(reverse)
AppInstallation.revenueAttributionRecords(reverse)
AppSubscriptionLineItem.usageRecords(reverse)
Article.comments(reverse)
Article.events(reverse)
Article.metafieldDefinitions(reverse)
Article.metafields(reverse)
Blog.articles(reverse)
Blog.events(reverse)
Blog.metafieldDefinitions(reverse)
Blog.metafields(reverse)
CalculatedOrder.addedDiscountApplications(reverse)
CalculatedOrder.addedLineItems(reverse)
CalculatedOrder.lineItems(reverse)
CalculatedOrder.stagedChanges(reverse)
CartTransform.metafields(reverse)
CashTrackingSession.adjustments(reverse)
CashTrackingSession.cashTransactions(reverse)
Channel.collectionPublicationsV3(reverse)
Channel.collections(reverse)
Channel.productPublications(reverse)
Channel.productPublicationsV3(reverse)

Updates

Developer changelog
Shopify Partners Slack
Shopify Editions

Business growth

Shopify Partners Program
Shopify App Store
Shopify Academy

Legal

Terms of service
API terms of use
Privacy policy
Partners Program Agreement

Shopify

About Shopify
Shopify Plus
Careers
Investors
Press and media