Skip to main content
Log inSign up
query

Returns an inventory Location resource by ID.

•

The ID of the location to return. If no ID is provided, the primary location of the Shop is returned.


Was this section helpful?

•

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•
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•
non-null

The address of this location.

addressVerified•
non-null

Whether the location address has been verified.

createdAt•
non-null

The date and time (ISO 8601 format) that the location was added to a shop.

deactivatable•
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•

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•
non-null

Whether this location can be deleted.

fulfillmentService•

Name of the service provider that fulfills from this location.

fulfillsOnlineOrders•
non-null

Whether this location can fulfill online orders.

hasActiveInventory•
non-null

Whether this location has active inventory.

hasUnfulfilledOrders•
non-null

Whether this location has orders that need to be fulfilled.

id•
non-null

A globally-unique ID.

inventoryLevel•

The quantities of an inventory item at this location.

inventoryLevels•
non-null

A list of the quantities of the inventory items that can be stocked at this location.

isActive•
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•
non-null

Whether this location is a fulfillment service.

legacyResourceId•
non-null

The ID of the corresponding resource in the REST Admin API.

localPickupSettingsV2•

Local pickup settings for the location.

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•
non-null

A list of custom fields that a merchant associates with a Shopify resource.

metafieldsByIdentifiers•
non-null

The metafields associated with the resource matching the supplied list of namespaces and keys.

name•
non-null

The name of the location.

shipsInventory•
non-null

Whether this location is used for calculating shipping rates. In multi-origin shipping mode, this flag is ignored.

suggestedAddresses•
non-null

List of suggested addresses for this location (empty if none).

updatedAt•
non-null

The date and time (ISO 8601 format) when the location was last updated.

isPrimary•
non-null

Whether the location is your primary location for shipping inventory.

metafieldDefinitions•
non-null

List of metafield definitions.


Was this section helpful?