Location

Also in this section

Represents the location where the physical good resides.

Show definition

# Represents the location where the physical good resides.
type Location implements LegacyInteroperability & Node {
  # The LocationAddress object for location.
  address: LocationAddress!
  # Name of the service provider that fulfills from this location.
  fulfillmentService: FulfillmentService
  # 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.
    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!
}

Implements

• Node
• LegacyInteroperability

Connections

inventoryLevels   (InventoryLevelConnection!)

Paginated list of inventory levels for inventory items stocked at the location.

Argument	Type	Default	Description
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	false	Reverse the order of the underlying list.

Fields

address   (LocationAddress!)

The LocationAddress object for location.

fulfillmentService   (FulfillmentService)

Name of the service provider that fulfills from this location.

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.

Argument	Type	Default	Description
inventoryItemId required	ID!		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.

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