Represents the location where the physical good resides. You can stock inventory at active locations. Active
locations that have fulfills_online_orders: true and are configured with a shipping rate, pickup enabled or
local delivery will be able to sell from their storefront.
activatable•
Boolean!
non-null
Whether the location can be reactivated. If false, then trying to activate the location with the
LocationActivate
mutation will return an error that describes why the location can't be activated.
address•
LocationAddress!
non-null
The address of this location.
addressVerified•
Boolean!
non-null
Whether the location address has been verified.
createdAt•
DateTime!
non-null
The date and time (ISO 8601 format) that the location was added to a shop.
deactivatable•
Boolean!
non-null
Whether this location can be deactivated. If true, then the location can be deactivated by calling the
LocationDeactivate
mutation. If false, then calling the mutation to deactivate it will return an error that describes why the
location can't be deactivated.
deactivatedAt•
String
The date and time (ISO 8601 format) that the location was deactivated at. For example, 3:30 pm on September 7, 2019 in the time zone of UTC (Universal Time Coordinated) is represented as "2019-09-07T15:50:00Z".
deletable•
Boolean!
non-null
Whether this location can be deleted.
fulfillmentService•
FulfillmentService
Name of the service provider that fulfills from this location.
fulfillsOnlineOrders•
Boolean!
non-null
Whether this location can fulfill online orders.
hasActiveInventory•
Boolean!
non-null
Whether this location has active inventory.
hasUnfulfilledOrders•
Boolean!
non-null
Whether this location has orders that need to be fulfilled.
id•
ID!
non-null
A globally-unique ID.
inventoryLevel•
InventoryLevel
The quantities of an inventory item at this location.
inventoryLevels•
InventoryLevelConnection!
non-null
A list of the quantities of the inventory items that can be stocked at this location.
isActive•
Boolean!
non-null
Whether the location is active. A deactivated location can be activated (change isActive: true) if it has
activatable set to true by calling the
locationActivate
mutation.
isFulfillmentService•
Boolean!
non-null
Whether this location is a fulfillment service.
legacyResourceId•
UnsignedInt64!
non-null
The ID of the corresponding resource in the REST Admin API.
localPickupSettingsV2•
DeliveryLocalPickupSettings
Local pickup settings for the location.
metafield•
Metafield
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•
MetafieldConnection!
non-null
A list of custom fields
that a merchant associates with a Shopify resource.
metafieldsByIdentifiers•
[Metafield]!
non-null
The metafields associated with the resource matching the supplied list of namespaces and keys.
name•
String!
non-null
The name of the location.
shipsInventory•
Boolean!
non-null
Whether this location is used for calculating shipping rates. In multi-origin shipping mode, this flag is ignored.
suggestedAddresses•
[LocationSuggestedAddress!]!
non-null
List of suggested addresses for this location (empty if none).
updatedAt•
DateTime!
non-null
The date and time (ISO 8601 format) when the location was last updated.
isPrimary•
Boolean!
non-nullDeprecated
Whether the location is your primary location for shipping inventory. The concept of a primary location is deprecated, shipsInventory can be used to get a fallback location
metafieldDefinitions•
MetafieldDefinitionConnection!
non-nullDeprecated
List of metafield definitions. This field will be removed in a future version. Use the root metafieldDefinitions field instead.
The delivery promise participants for the product variant.
displayName•
String!
non-null
Display name of the variant, based on product's title + variant's title.
events•
EventConnection!
non-null
The paginated list of events associated with the host subject.
id•
ID!
non-null
A globally-unique ID.
image•
Image
The featured image for the variant.
inventoryItem•
InventoryItem!
non-null
The inventory item, which is used to query for inventory information.
inventoryPolicy•
ProductVariantInventoryPolicy!
non-null
Whether customers are allowed to place an order for the product variant when it's out of stock.
inventoryQuantity•
Int
The total sellable quantity of the variant.
legacyResourceId•
UnsignedInt64!
non-null
The ID of the corresponding resource in the REST Admin API.
media•
MediaConnection!
non-null
The media associated with the product variant.
metafield•
Metafield
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•
MetafieldConnection!
non-null
A list of custom fields
that a merchant associates with a Shopify resource.
metafieldsByIdentifiers•
[Metafield]!
non-null
The metafields associated with the resource matching the supplied list of namespaces and keys.
position•
Int!
non-null
The order of the product variant in the list of product variants. The first position in the list is 1.
price•
Money!
non-null
The price of the product variant in the default shop currency.
product•
Product!
non-null
The product that this variant belongs to.
productParents•
ProductConnection!
non-null
A list of products that have product variants that contain this variant as a product component.
productVariantComponents•
ProductVariantComponentConnection!
non-null
A list of the product variant components.
requiresComponents•
Boolean!
non-null
Whether a product variant requires components. The default value is false.
If true, then the product variant can only be purchased as a parent bundle with components and it will be omitted
from channels that don't support bundles.
selectedOptions•
[SelectedOption!]!
non-null
List of product options applied to the variant.
sellableOnlineQuantity•
Int!
non-null
The total sellable quantity of the variant for online channels.
This doesn't represent the total available inventory or capture
limitations based on customer location.
sellingPlanGroups•
SellingPlanGroupConnection!
non-null
A list of all selling plan groups defined in the current shop associated with the product variant.
sellingPlanGroupsCount•
Count
Count of selling plan groups associated with the product variant.
sku•
String
A case-sensitive identifier for the product variant in the shop.
Required in order to connect to a fulfillment service.
taxable•
Boolean!
non-null
Whether a tax is charged when the product variant is sold.
taxCode•
String
The tax code for the product variant.
title•
String!
non-null
The title of the product variant.
translations•
[Translation!]!
non-null
The published translations associated with the resource.
unitPriceMeasurement•
UnitPriceMeasurement
The unit price measurement for the variant.
updatedAt•
DateTime!
non-null
The date and time (ISO 8601 format) when the product variant was last modified.
metafieldDefinitions•
MetafieldDefinitionConnection!
non-nullDeprecated
List of metafield definitions. This field will be removed in a future version. Use the root metafieldDefinitions field instead.
presentmentPrices•
ProductVariantPricePairConnection!
non-nullDeprecated
List of prices and compare-at prices in the presentment currencies for this shop. Use contextualPricing instead.
sellingPlanGroupCount•
Int!
non-nullDeprecated
Count of selling plan groups associated with the product variant. Use sellingPlanGroupsCount instead.
storefrontId•
StorefrontID!
non-nullDeprecated
The Storefront GraphQL API ID of the ProductVariant.
As of the 2022-04 version release, the Storefront GraphQL API will no longer return Base64 encoded IDs to match the behavior of the Admin GraphQL API. Therefore, you can safely use the id field's value instead. Use id instead.
