Location object

Version unstable

Represents the location where the physical good resides.

Connections

  • inventoryLevels (InventoryLevelConnection!)

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

    Argument 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 for more information about using filters.

    reverse ( Boolean )

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

  • metafieldDefinitions (MetafieldDefinitionConnection!)

    List of metafield definitions.

    Argument 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.

    namespace ( String )

    Filter metafield definitions by namespace.

    pinnedStatus ( MetafieldDefinitionPinnedStatus )

    Filter by the definition's pinned status.
    Default value: ANY

    query ( String )

    Supported filter parameters:

    • key
    • namespace
    • owner_type

    See the detailed search syntax for more information about using filters.

    reverse ( Boolean )

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

    sortKey ( MetafieldDefinitionSortKeys )

    Sort the underlying list by the given key.
    Default value: ID

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.

    Argument Description
    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!)