Location

Required access

Any of read_locations, read_products access scopes

Represents the location where the physical good resides.

Show definition
# Represents the location where the physical good resides.
type Location implements Node {
  # Globally unique identifier.
  id: ID!

  # The LocationAddress object for location.
  address: LocationAddress!

  # Name of the service provider that fulfills from this location.
  fulfillmentService: FulfillmentService

  # 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 up to the first `n` elements from the list.
    first: Int

    # Returns the elements that come after the specified cursor.
    after: String

    # Returns up to the last `n` elements from the list.
    last: Int

    # Returns the elements that come before the specified cursor.
    before: String

    # Reverse the order of the underlying list.
    reverse: Boolean = false

    # Supported filter parameters:
    #  - `inventory_item_id`
    #  - `inventory_group_id`
    #  - `updated_at`
    #  - `created_at`
    query: String
  ): InventoryLevelConnection!

  # Whether the location is active.
  isActive: Boolean!
  isPrimary: Boolean!

  # The name of the location.
  name: String!

  # Indicates whether or not this location ships inventory.
  shipsInventory: Boolean!
}

Implements

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:

  • inventory_item_id
  • inventory_group_id
  • updated_at
  • created_at
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.

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.

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