Location

This page was printed on Aug 21, 2019. For the current version, visit https://help.shopify.com/en/api/graphql-admin-api/reference/object/location.
Version 2019-04

Represents the location where the physical good resides.

Show definition 
"""
Represents the location where the physical good resides.
"""
type Location implements LegacyInteroperability & Node {
  """
  Whether this location can be reactivated.
  """
  activatable: Boolean!
  """
  The LocationAddress object for location.
  """
  address: LocationAddress!
  """
  Whether the location address has been verified.
  """
  addressVerified: Boolean!
  """
  Whether this location can be deactivated.
  """
  deactivatable: Boolean!
  """
  Date and time the location was deactivated (null if location is still active).
  Following UTC ISO8601 format, e.g.: "2019-04-24T13:42:24Z".
  """
  deactivatedAt: String
  """
  Whether this location can be deleted.
  """
  deletable: Boolean!
  """
  Name of the service provider that fulfills from this location.
  """
  fulfillmentService: FulfillmentService
  """
  Indicates whether this location can fulfill online orders.
  """
  fulfillsOnlineOrders: Boolean!
  """
  Indicates whether or not this location has active inventory.
  """
  hasActiveInventory: Boolean!
  """
  Indicates whether or not this location has unfulfilled orders.
  """
  hasUnfulfilledOrders: Boolean!
  """
  Globally unique identifier.
  """
  id: ID!
  """
  A single inventory level for the given inventory item.
  """
  inventoryLevel(
    """
    Specifies the inventory item ID for the inventory level to be returned.
    """
    inventoryItemId: ID!
  ): InventoryLevel
  """
  Paginated list of inventory levels for inventory items stocked at the location.
  """
  inventoryLevels(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first `n` elements from the list.
    """
    first: Int
    """
    Returns up to the last `n` elements from the list.
    """
    last: Int
    """
    Supported filter parameters:
     - `created_at`
     - `inventory_group_id`
     - `inventory_item_id`
     - `updated_at`
    See the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax).
    """
    query: String
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
  ): InventoryLevelConnection!
  """
  Whether the location is active.
  """
  isActive: Boolean!
  isPrimary: Boolean!
  """
  The ID of the corresponding resource in the REST Admin API.
  """
  legacyResourceId: UnsignedInt64!
  """
  The name of the location.
  """
  name: String!
  """
  Indicates whether or not this location ships inventory.
  """
  shipsInventory: Boolean!
  """
  List of suggested addresses for this location (empty if none).
  """
  suggestedAddresses: [LocationSuggestedAddress!]!
}

Implements

Connections

inventoryLevels (InventoryLevelConnection!)

Paginated list of inventory levels for inventory items stocked at the location.
after ( String )

Returns the elements that come after the specified cursor.
before ( String )

Returns the elements that come before the specified cursor.
first ( Int )

Returns up to the first n elements from the list.
last ( Int )

Returns up to the last n elements from the list.
query ( String )

Supported filter parameters:

  • created_at
  • inventory_group_id
  • inventory_item_id
  • updated_at

See the detailed search syntax.
reverse ( Boolean )

Reverse the order of the underlying list.
Default value: true

Fields

activatable (Boolean!)

Whether this location can be reactivated.
address (LocationAddress!)

The LocationAddress object for location.
addressVerified (Boolean!)

Whether the location address has been verified.
deactivatable (Boolean!)

Whether this location can be deactivated.
deactivatedAt (String)

Date and time the location was deactivated (null if location is still active). Following UTC ISO8601 format, e.g.: "2019-04-24T13:42:24Z".
deletable (Boolean!)

Whether this location can be deleted.
fulfillmentService (FulfillmentService)

Name of the service provider that fulfills from this location.
fulfillsOnlineOrders (Boolean!)

Indicates whether this location can fulfill online orders.
hasActiveInventory (Boolean!)

Indicates whether or not this location has active inventory.
hasUnfulfilledOrders (Boolean!)

Indicates whether or not this location has unfulfilled orders.
id (ID!)

Globally unique identifier.
inventoryLevel (InventoryLevel)

A single inventory level for the given inventory item.
inventoryItemId ( ID! ) required

Specifies the inventory item ID for the inventory level to be returned.
isActive (Boolean!)

Whether the location is active.
legacyResourceId (UnsignedInt64!)

The ID of the corresponding resource in the REST Admin API.
name (String!)

The name of the location.
shipsInventory (Boolean!)

Indicates whether or not this location ships inventory.
suggestedAddresses ([LocationSuggestedAddress!]!)

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

Deprecated fields

Show/Hide
isPrimary (Boolean!) deprecated

Deprecation warning

The concept of a primary location is deprecated, shipsInventory can be used to get a fallback location
Version 2019-07 (Latest)

Represents the location where the physical good resides.

Show definition 
"""
Represents the location where the physical good resides.
"""
type Location implements LegacyInteroperability & Node {
  """
  Whether this location can be reactivated.
  """
  activatable: Boolean!
  """
  The LocationAddress object for location.
  """
  address: LocationAddress!
  """
  Whether the location address has been verified.
  """
  addressVerified: Boolean!
  """
  Whether this location can be deactivated.
  """
  deactivatable: Boolean!
  """
  Date and time the location was deactivated (null if location is still active).
  Following UTC ISO8601 format, e.g.: "2019-04-24T13:42:24Z".
  """
  deactivatedAt: String
  """
  Whether this location can be deleted.
  """
  deletable: Boolean!
  """
  Name of the service provider that fulfills from this location.
  """
  fulfillmentService: FulfillmentService
  """
  Indicates whether this location can fulfill online orders.
  """
  fulfillsOnlineOrders: Boolean!
  """
  Indicates whether or not this location has active inventory.
  """
  hasActiveInventory: Boolean!
  """
  Indicates whether or not this location has unfulfilled orders.
  """
  hasUnfulfilledOrders: Boolean!
  """
  Globally unique identifier.
  """
  id: ID!
  """
  A single inventory level for the given inventory item.
  """
  inventoryLevel(
    """
    Specifies the inventory item ID for the inventory level to be returned.
    """
    inventoryItemId: ID!
  ): InventoryLevel
  """
  Paginated list of inventory levels for inventory items stocked at the location.
  """
  inventoryLevels(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first `n` elements from the list.
    """
    first: Int
    """
    Returns up to the last `n` elements from the list.
    """
    last: Int
    """
    Supported filter parameters:
     - `created_at`
     - `inventory_group_id`
     - `inventory_item_id`
     - `updated_at`
    See the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax).
    """
    query: String
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
  ): InventoryLevelConnection!
  """
  Whether the location is active.
  """
  isActive: Boolean!
  isPrimary: Boolean!
  """
  The ID of the corresponding resource in the REST Admin API.
  """
  legacyResourceId: UnsignedInt64!
  """
  The name of the location.
  """
  name: String!
  """
  Indicates whether or not this location ships inventory.
  """
  shipsInventory: Boolean!
  """
  List of suggested addresses for this location (empty if none).
  """
  suggestedAddresses: [LocationSuggestedAddress!]!
}

Implements

Connections

inventoryLevels (InventoryLevelConnection!)

Paginated list of inventory levels for inventory items stocked at the location.
after ( String )

Returns the elements that come after the specified cursor.
before ( String )

Returns the elements that come before the specified cursor.
first ( Int )

Returns up to the first n elements from the list.
last ( Int )

Returns up to the last n elements from the list.
query ( String )

Supported filter parameters:

  • created_at
  • inventory_group_id
  • inventory_item_id
  • updated_at

See the detailed search syntax.
reverse ( Boolean )

Reverse the order of the underlying list.
Default value: true

Fields

activatable (Boolean!)

Whether this location can be reactivated.
address (LocationAddress!)

The LocationAddress object for location.
addressVerified (Boolean!)

Whether the location address has been verified.
deactivatable (Boolean!)

Whether this location can be deactivated.
deactivatedAt (String)

Date and time the location was deactivated (null if location is still active). Following UTC ISO8601 format, e.g.: "2019-04-24T13:42:24Z".
deletable (Boolean!)

Whether this location can be deleted.
fulfillmentService (FulfillmentService)

Name of the service provider that fulfills from this location.
fulfillsOnlineOrders (Boolean!)

Indicates whether this location can fulfill online orders.
hasActiveInventory (Boolean!)

Indicates whether or not this location has active inventory.
hasUnfulfilledOrders (Boolean!)

Indicates whether or not this location has unfulfilled orders.
id (ID!)

Globally unique identifier.
inventoryLevel (InventoryLevel)

A single inventory level for the given inventory item.
inventoryItemId ( ID! ) required

Specifies the inventory item ID for the inventory level to be returned.
isActive (Boolean!)

Whether the location is active.
legacyResourceId (UnsignedInt64!)

The ID of the corresponding resource in the REST Admin API.
name (String!)

The name of the location.
shipsInventory (Boolean!)

Indicates whether or not this location ships inventory.
suggestedAddresses ([LocationSuggestedAddress!]!)

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

Deprecated fields

Show/Hide
isPrimary (Boolean!) deprecated

Deprecation warning

The concept of a primary location is deprecated, shipsInventory can be used to get a fallback location
Version 2019-10 (Release candidate)

Represents the location where the physical good resides.

Show definition 
"""
Represents the location where the physical good resides.
"""
type Location implements LegacyInteroperability & Node {
  """
  Whether this location can be reactivated.
  """
  activatable: Boolean!
  """
  The LocationAddress object for location.
  """
  address: LocationAddress!
  """
  Whether the location address has been verified.
  """
  addressVerified: Boolean!
  """
  Whether this location can be deactivated.
  """
  deactivatable: Boolean!
  """
  Date and time the location was deactivated (null if location is still active).
  Following UTC ISO8601 format, e.g.: "2019-04-24T13:42:24Z".
  """
  deactivatedAt: String
  """
  Whether this location can be deleted.
  """
  deletable: Boolean!
  """
  Name of the service provider that fulfills from this location.
  """
  fulfillmentService: FulfillmentService
  """
  Indicates whether this location can fulfill online orders.
  """
  fulfillsOnlineOrders: Boolean!
  """
  Indicates whether or not this location has active inventory.
  """
  hasActiveInventory: Boolean!
  """
  Indicates whether or not this location has unfulfilled orders.
  """
  hasUnfulfilledOrders: Boolean!
  """
  Globally unique identifier.
  """
  id: ID!
  """
  A single inventory level for the given inventory item.
  """
  inventoryLevel(
    """
    Specifies the inventory item ID for the inventory level to be returned.
    """
    inventoryItemId: ID!
  ): InventoryLevel
  """
  Paginated list of inventory levels for inventory items stocked at the location.
  """
  inventoryLevels(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first `n` elements from the list.
    """
    first: Int
    """
    Returns up to the last `n` elements from the list.
    """
    last: Int
    """
    Supported filter parameters:
     - `created_at`
     - `inventory_group_id`
     - `inventory_item_id`
     - `updated_at`
    See the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax).
    """
    query: String
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
  ): InventoryLevelConnection!
  """
  Whether the location is active.
  """
  isActive: Boolean!
  isPrimary: Boolean!
  """
  The ID of the corresponding resource in the REST Admin API.
  """
  legacyResourceId: UnsignedInt64!
  """
  The name of the location.
  """
  name: String!
  """
  Indicates whether or not this location ships inventory.
  """
  shipsInventory: Boolean!
  """
  List of suggested addresses for this location (empty if none).
  """
  suggestedAddresses: [LocationSuggestedAddress!]!
}

Implements

Connections

inventoryLevels (InventoryLevelConnection!)

Paginated list of inventory levels for inventory items stocked at the location.
after ( String )

Returns the elements that come after the specified cursor.
before ( String )

Returns the elements that come before the specified cursor.
first ( Int )

Returns up to the first n elements from the list.
last ( Int )

Returns up to the last n elements from the list.
query ( String )

Supported filter parameters:

  • created_at
  • inventory_group_id
  • inventory_item_id
  • updated_at

See the detailed search syntax.
reverse ( Boolean )

Reverse the order of the underlying list.
Default value: true

Fields

activatable (Boolean!)

Whether this location can be reactivated.
address (LocationAddress!)

The LocationAddress object for location.
addressVerified (Boolean!)

Whether the location address has been verified.
deactivatable (Boolean!)

Whether this location can be deactivated.
deactivatedAt (String)

Date and time the location was deactivated (null if location is still active). Following UTC ISO8601 format, e.g.: "2019-04-24T13:42:24Z".
deletable (Boolean!)

Whether this location can be deleted.
fulfillmentService (FulfillmentService)

Name of the service provider that fulfills from this location.
fulfillsOnlineOrders (Boolean!)

Indicates whether this location can fulfill online orders.
hasActiveInventory (Boolean!)

Indicates whether or not this location has active inventory.
hasUnfulfilledOrders (Boolean!)

Indicates whether or not this location has unfulfilled orders.
id (ID!)

Globally unique identifier.
inventoryLevel (InventoryLevel)

A single inventory level for the given inventory item.
inventoryItemId ( ID! ) required

Specifies the inventory item ID for the inventory level to be returned.
isActive (Boolean!)

Whether the location is active.
legacyResourceId (UnsignedInt64!)

The ID of the corresponding resource in the REST Admin API.
name (String!)

The name of the location.
shipsInventory (Boolean!)

Indicates whether or not this location ships inventory.
suggestedAddresses ([LocationSuggestedAddress!]!)

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

Deprecated fields

Show/Hide
isPrimary (Boolean!) deprecated

Deprecation warning

The concept of a primary location is deprecated, shipsInventory can be used to get a fallback location

Sign up for a Partner account to get started.

Sign up