Location
Requires access scope, access scope or access scope.
Represents the location where the physical good resides. You can stock inventory at active locations. Active
locations that have and are configured with a shipping rate, pickup enabled or
local delivery will be able to sell from their storefront.
Anchor to Fields and connectionsFields and connections
- Anchor to activatableactivatable•Boolean!non-null
- Anchor to addressaddress•Location
Address!non-null The address of this location.
- Anchor to addressVerifiedaddress•Boolean!non-null
Verified Whether the location address has been verified.
- Anchor to createdAtcreated•Date
At Time!non-null The date and time (ISO 8601 format) that the location was added to a shop.
- Anchor to deactivatabledeactivatable•Boolean!non-null
- Anchor to deactivatedAtdeactivated•String
At 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
".- Anchor to deletabledeletable•Boolean!non-null
Whether this location can be deleted.
- Anchor to fulfillmentServicefulfillment•Fulfillment
Service Service Name of the service provider that fulfills from this location.
- Anchor to fulfillsOnlineOrdersfulfills•Boolean!non-null
Online Orders Whether this location can fulfill online orders.
- Anchor to hasActiveInventoryhas•Boolean!non-null
Active Inventory Whether this location has active inventory.
- Anchor to hasUnfulfilledOrdershas•Boolean!non-null
Unfulfilled Orders Whether this location has orders that need to be fulfilled.
- •ID!non-null
A globally-unique ID.
- Anchor to inventoryLevelinventory•Inventory
Level Level The quantities of an inventory item at this location.
- Anchor to inventoryLevelsinventory•Inventory
Levels Level Connection!non-null A list of the quantities of the inventory items that can be stocked at this location.
- Anchor to isActiveis•Boolean!non-null
Active - Anchor to isFulfillmentServiceis•Boolean!non-null
Fulfillment Service Whether this location is a fulfillment service.
- Anchor to legacyResourceIdlegacy•Unsigned
Resource Id Int64!non-null The ID of the corresponding resource in the REST Admin API.
- Anchor to localPickupSettingsV2local•Delivery
Pickup Settings V2 Local Pickup Settings Local pickup settings for the location.
- Anchor to metafieldmetafield•Metafield
A custom field, including its
namespaceandkey, that's associated with a Shopify resource for the purposes of adding and storing additional information.- Anchor to metafieldsmetafields•Metafield
Connection!non-null A list of custom fields that a merchant associates with a Shopify resource.
- Anchor to namename•String!non-null
The name of the location.
- Anchor to shipsInventoryships•Boolean!non-null
Inventory Whether this location is used for calculating shipping rates. In multi-origin shipping mode, this flag is ignored.
- Anchor to suggestedAddressessuggested•[Location
Addresses Suggested Address!]!non-null List of suggested addresses for this location (empty if none).
- Anchor to updatedAtupdated•Date
At Time!non-null The date and time (ISO 8601 format) when the location was last updated.
Deprecated fields and connections
- Anchor to isPrimaryis•Boolean!non-nullDeprecated
Primary - Anchor to metafieldDefinitionsmetafield•Metafield
Definitions Definition Connection!non-nullDeprecated - Anchor to privateMetafieldprivate•Private
Metafield MetafieldDeprecated - Anchor to privateMetafieldsprivate•Private
Metafields Metafield Connection!non-nullDeprecated
Anchor to QueriesQueries
- •query
Returns an inventory Location resource by ID.
- •query
Returns a list of active inventory locations.
- Anchor to locationsAvailableForDeliveryProfilesConnectionlocations•query
Available For Delivery Profiles Connection Returns a list of all origin locations available for a delivery profile.
Anchor to MutationsMutations
- •mutation
Activates a location so that you can stock inventory at the location. Refer to the
andactivatablefields on theLocationobject.- Anchor to locationIdlocation•ID!required
Id The ID of a location to activate.
Arguments
- Anchor to locationlocation•Location
The location that was activated.
- Anchor to locationActivateUserErrorslocation•[Location
Activate User Errors Activate User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Adds a new location.
- Anchor to inputinput•Location
Add Input!required The properties of the location to add.
Arguments
- Anchor to locationlocation•Location
The location that was added.
- Anchor to userErrorsuser•[Location
Errors Add User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Deactivates a location and moves inventory, pending orders, and moving transfers to a destination location.
- Anchor to destinationLocationIddestination•ID
Location Id The ID of a destination location to which inventory, pending orders and moving transfers will be moved from the location to deactivate.
- Anchor to locationIdlocation•ID!required
Id The ID of a location to deactivate.
Arguments
- Anchor to locationlocation•Location
The location that was deactivated.
- Anchor to locationDeactivateUserErrorslocation•[Location
Deactivate User Errors Deactivate User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Edits an existing location.
As of the 2023-10 API version, apps can change the name and address of their fulfillment service locations.
- •ID!required
The ID of a location to edit.
- Anchor to inputinput•Location
Edit Input!required The updated properties for the location.
Arguments
- Anchor to locationlocation•Location
The location that was edited.
- Anchor to userErrorsuser•[Location
Errors Edit User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields