Choose a version:

Location

object

Requires read_locations access scope, read_inventory access scope or read_markets_home access scope.

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.

Anchor to FieldsFields

Anchor to activatableactivatable •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.
Anchor to addressaddress •LocationAddress! non-null: The address of this location.
Anchor to addressVerifiedaddressVerified •Boolean! non-null: Whether the location address has been verified.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time (ISO 8601 format) that the location was added to a shop.
Anchor to deactivatabledeactivatable •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.
Anchor to deactivatedAtdeactivatedAt •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".
Anchor to deletabledeletable •Boolean! non-null: Whether this location can be deleted.
Anchor to fulfillmentServicefulfillmentService •FulfillmentService: Name of the service provider that fulfills from this location.
Anchor to fulfillsOnlineOrdersfulfillsOnlineOrders •Boolean! non-null: Whether this location can fulfill online orders.
Anchor to hasActiveInventoryhasActiveInventory •Boolean! non-null: Whether this location has active inventory.
Anchor to hasUnfulfilledOrdershasUnfulfilledOrders •Boolean! non-null: Whether this location has orders that need to be fulfilled.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to inventoryLevelinventoryLevel •InventoryLevel: The quantities of an inventory item at this location.
Anchor to inventoryLevelsinventoryLevels •InventoryLevelConnection! non-null: A list of the quantities of the inventory items that can be stocked at this location.
Anchor to isActiveisActive •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.
Anchor to isFulfillmentServiceisFulfillmentService •Boolean! non-null: Whether this location is a fulfillment service.
Anchor to legacyResourceIdlegacyResourceId •UnsignedInt64! non-null: The ID of the corresponding resource in the REST Admin API.
Anchor to localPickupSettingsV2localPickupSettingsV2 •DeliveryLocalPickupSettings: Local pickup settings for the location.
Anchor to metafieldmetafield •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.
Anchor to metafieldsmetafields •MetafieldConnection! non-null: A list of custom fields that a merchant associates with a Shopify resource.
Anchor to metafieldsByIdentifiersmetafieldsByIdentifiers •[Metafield]! non-null: The metafields associated with the resource matching the supplied list of namespaces and keys.
Anchor to namename •String! non-null: The name of the location.
Anchor to shipsInventoryshipsInventory •Boolean! non-null: Whether this location is used for calculating shipping rates. In multi-origin shipping mode, this flag is ignored.
Anchor to suggestedAddressessuggestedAddresses •[LocationSuggestedAddress!]! non-null: List of suggested addresses for this location (empty if none).
Anchor to updatedAtupdatedAt •DateTime! non-null: The date and time (ISO 8601 format) when the location was last updated.

Deprecated fields

Anchor to isPrimaryisPrimary •Boolean! non-nullDeprecated
Anchor to metafieldDefinitionsmetafieldDefinitions •MetafieldDefinitionConnection! non-nullDeprecated

Was this section helpful?

Anchor to QueriesQueries

Anchor to location location •query: Returns an inventory Location resource by ID.
Anchor to locationByIdentifier locationByIdentifier •query: Return a location by an identifier.
Anchor to locations locations •query: Returns a list of active inventory locations.
Anchor to locationsAvailableForDeliveryProfilesConnection locationsAvailableForDeliveryProfilesConnection •query: Returns a list of all origin locations available for a delivery profile.
Anchor to locationsAvailableForDeliveryProfiles locationsAvailableForDeliveryProfiles •query Deprecated

Was this section helpful?

Anchor to MutationsMutations

Anchor to locationActivate locationActivate •mutation: Activates a location so that you can stock inventory at the location. Refer to the isActive and activatable fields on the Location object.
Anchor to locationAdd locationAdd •mutation: Adds a new location.
Anchor to locationDeactivate locationDeactivate •mutation: Deactivates a location and moves inventory, pending orders, and moving transfers to a destination location.
Anchor to locationEdit locationEdit •mutation: Edits an existing location.

As of the 2023-10 API version, apps can change the name and address of their fulfillment service locations.

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to HasMetafieldDefinitions HasMetafieldDefinitions •interface
Anchor to HasMetafields HasMetafields •interface
Anchor to LegacyInteroperability LegacyInteroperability •interface
Anchor to Node Node •interface

Was this section helpful?