Skip to main content
Anchor to locationsAvailableForDeliveryProfiles

locationsAvailableForDeliveryProfiles

query
Deprecated. Use locationsAvailableForDeliveryProfilesConnection instead.

Returns a list of all origin locations available for a delivery profile.

Anchor to Possible returnsPossible returns

Anchor to LocationLocation
•[Location!]

A physical location where merchants store and fulfill inventory. Locations include retail stores, warehouses, popups, dropshippers, or other places where inventory is managed or stocked.

Active locations can fulfill online orders when configured with shipping rates, local pickup, or local delivery options. Locations track inventory quantities for products and process order fulfillment. Third-party apps using FulfillmentService can create and manage their own locations.

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.

Arguments

Anchor to inventoryItemIdinventoryItemId
•ID!
required

The ID of the inventory item to obtain the inventory level for.

Anchor to includeInactiveincludeInactive
•Boolean
Default:false

Whether to return the inventory level if it is inactive.

Anchor to inventoryLevelsinventoryLevels
•InventoryLevelConnection!
non-null

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

Arguments

Anchor to includeInactiveincludeInactive
•Boolean
Default:false

Whether to include inactive inventory levels.

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to queryquery
•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to created_at
•time
Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to inventory_group_id
•id
Anchor to inventory_item_id
•id
Anchor to updated_at
•time
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.

Arguments

Anchor to namespacenamespace
•String

The container the metafield belongs to. If omitted, the app-reserved namespace will be used.

Anchor to keykey
•String!
required

The key for the metafield.

Anchor to metafieldsmetafields
•MetafieldConnection!
non-null

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

Arguments

Anchor to namespacenamespace
•String

The metafield namespace to filter by. If omitted, all metafields are returned.

Anchor to keyskeys
•[String!]

List of keys of metafields in the format namespace.key, will be returned in the same format.

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to namename
•String!
non-null

The name of the location.

Anchor to shipsInventoryshipsInventory
•Boolean!
non-null

Legacy field indicating this location was designated for shipping. All locations with valid addresses can now ship.

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.

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

Arguments

Anchor to namespacenamespace
•String

Filter metafield definitions by namespace.

Anchor to pinnedStatuspinnedStatus
•MetafieldDefinitionPinnedStatus
Default:ANY

Filter by the definition's pinned status.

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•MetafieldDefinitionSortKeys
Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Anchor to queryquery
•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default
•string

Filter by a case-insensitive search of multiple fields in a document.

Example:

  • query=Bob Norman
  • query=title:green hoodie
Anchor to created_at
•time

Filter by the date and time when the metafield definition was created.

Example:

  • created_at:>2020-10-21T23:39:20Z
  • created_at:<now
  • created_at:<=2024
Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to key
•string

Filter by the metafield definition key field.

Example:

  • key:some-key
Anchor to namespace
•string

Filter by the metafield definition namespace field.

Example:

  • namespace:some-namespace
Anchor to owner_type
•string

Filter by the metafield definition ownerType field.

Example:

  • owner_type:PRODUCT
Anchor to type
•string

Filter by the metafield definition type field.

Example:

  • type:single_line_text_field
Anchor to updated_at
•time

Filter by the date and time when the metafield definition was last updated.

Example:

  • updated_at:>2020-10-21T23:39:20Z
  • updated_at:<now
  • updated_at:<=2024
Was this section helpful?