Location
object

Choose a version:

Requires the read_locations access scope.

Represents the location where the physical good resides.

Anchor to section titled 'Fields and connections'

Fields and connections

Anchor to Location.activatable activatable Boolean! non-null: Whether this location can be reactivated.
Anchor to Location.address address LocationAddress! non-null: The address of this location.
Anchor to Location.addressVerified addressVerified Boolean! non-null: Whether the location address has been verified.
Anchor to Location.createdAt createdAt DateTime! non-null: The date and time (ISO 8601 format) that the location was added to a shop.
Anchor to Location.deactivatable deactivatable Boolean! non-null: Whether this location can be deactivated.
Anchor to Location.deactivatedAt 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".
Anchor to Location.deletable deletable Boolean! non-null: Whether this location can be deleted.
Anchor to Location.fulfillmentService fulfillmentService FulfillmentService: Name of the service provider that fulfills from this location.
Anchor to Location.fulfillsOnlineOrders fulfillsOnlineOrders Boolean! non-null: Whether this location can fulfill online orders.
Anchor to Location.hasActiveInventory hasActiveInventory Boolean! non-null: Whether this location has active inventory.
Anchor to Location.hasUnfulfilledOrders hasUnfulfilledOrders Boolean! non-null: Whether this location has orders that need to be fulfilled.
Anchor to Location.id id ID! non-null: A globally-unique ID.
Anchor to Location.inventoryLevel inventoryLevel InventoryLevel: The quantities of an inventory item at this location.
Anchor to Location.inventoryLevels inventoryLevels InventoryLevelConnection! non-null: A list of the quantities of the inventory items that can be stocked at this location.
Anchor to Location.isActive isActive Boolean! non-null: Whether the location is active.
Anchor to Location.isFulfillmentService isFulfillmentService Boolean! non-null: Whether this location is a fulfillment service.
Anchor to Location.legacyResourceId legacyResourceId UnsignedInt64! non-null: The ID of the corresponding resource in the REST Admin API.
Anchor to Location.localPickupSettingsV2 localPickupSettingsV2 DeliveryLocalPickupSettings: Local pickup settings for the location.
Anchor to Location.metafield 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.
Anchor to Location.metafields metafields MetafieldConnection! non-null: A list of custom fields that a merchant associates with a Shopify resource.
Anchor to Location.name name String! non-null: The name of the location.
Anchor to Location.shipsInventory shipsInventory Boolean! non-null: Whether this location is used for calculating shipping rates. In multi-origin shipping mode, this flag is ignored.
Anchor to Location.suggestedAddresses suggestedAddresses [LocationSuggestedAddress!]! non-null: List of suggested addresses for this location (empty if none).
Anchor to Location.updatedAt updatedAt DateTime! non-null: The date and time (ISO 8601 format) when the location was last updated.

Was this section helpful?

Map

Fields and connections from

CashTrackingSession.location
DeliveryCarrierServiceAndLocations.locations
DeliveryLocationGroup.locations
DeliveryProfile.unassignedLocations
DeliveryProfile.unassignedLocationsPaginated
DeliveryPromiseProvider.location
Fulfillment.location
FulfillmentOrderAssignedLocation.location
FulfillmentOrderDestination.location
FulfillmentOrderLocationForMove.location
FulfillmentService.location
InventoryChange.location

Possible types in

MetafieldReferencer

Location

Anchor to section titled 'Queries'

Queries

Anchor to location location query: Returns an inventory Location resource by ID.
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.

Was this section helpful?

<?>

Location Queries

Location

Queried by

Anchor to section titled 'Mutations'

Mutations

Anchor to locationActivate locationActivate mutation: Activates a location.
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?

<~>

Location Mutations

Location

Mutated by

Anchor to section titled 'Implements'

Implements

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

Was this section helpful?

||-

Location Implements

Location

Locationobject

Fields and connections

Fields and connections from

Possible types in

Queries

Queried by

Mutations

Mutated by

Implements

Implements

Location
object