API version: unstable
API version: 2021-04 Release candidate
API version: 2021-01 Latest
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

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

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

    The name of the location.

  • shipsInventory (Boolean!)

    Indicates whether or not this location is used for calculating shipping rates.

  • suggestedAddresses ([LocationSuggestedAddress!]!)

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

Types that return Location

Implements

Deprecated fields

  • isPrimary (Boolean!) deprecated

    Whether the location is your primary location for shipping inventory.

    Deprecation warning

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

Version 2021-04 (Release candidate)

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

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

    The name of the location.

  • shipsInventory (Boolean!)

    Indicates whether or not this location is used for calculating shipping rates.

  • suggestedAddresses ([LocationSuggestedAddress!]!)

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

Types that return Location

Implements

Deprecated fields

  • isPrimary (Boolean!) deprecated

    Whether the location is your primary location for shipping inventory.

    Deprecation warning

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

Version 2021-04 (Release candidate)

An auto-generated type for paginating through multiple Locations.

On this page

Fields

Version 2021-04 (Release candidate)

An auto-generated type which holds one Location and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • node (Location!)

    The item at the end of LocationEdge.

Types that return LocationEdge

Version 2021-01 (Latest)

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

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

    The name of the location.

  • shipsInventory (Boolean!)

    Indicates whether or not this location is used for calculating shipping rates.

  • suggestedAddresses ([LocationSuggestedAddress!]!)

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

Types that return Location

Implements

Deprecated fields

  • isPrimary (Boolean!) deprecated

    Whether the location is your primary location for shipping inventory.

    Deprecation warning

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

Version 2021-01 (Latest)

An auto-generated type for paginating through multiple Locations.

On this page

Fields

Version 2021-01 (Latest)

An auto-generated type which holds one Location and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • node (Location!)

    The item at the end of LocationEdge.

Types that return LocationEdge

Version 2020-10

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

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

    The name of the location.

  • shipsInventory (Boolean!)

    Indicates whether or not this location is used for calculating shipping rates.

  • suggestedAddresses ([LocationSuggestedAddress!]!)

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

Types that return Location

Implements

Deprecated fields

  • isPrimary (Boolean!) deprecated

    Whether the location is your primary location for shipping inventory.

    Deprecation warning

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

Version 2020-10

An auto-generated type for paginating through multiple Locations.

On this page

Fields

Version 2020-10

An auto-generated type which holds one Location and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • node (Location!)

    The item at the end of LocationEdge.

Types that return LocationEdge

Version 2020-07

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

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

    The name of the location.

  • shipsInventory (Boolean!)

    Indicates whether or not this location is used for calculating shipping rates.

  • suggestedAddresses ([LocationSuggestedAddress!]!)

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

Types that return Location

Implements

Deprecated fields

  • isPrimary (Boolean!) deprecated

    Whether the location is your primary location for shipping inventory.

    Deprecation warning

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

Version 2020-07

An auto-generated type for paginating through multiple Locations.

On this page

Fields

Version 2020-07

An auto-generated type which holds one Location and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • node (Location!)

    The item at the end of LocationEdge.

Types that return LocationEdge

Version 2020-04

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

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

    The name of the location.

  • shipsInventory (Boolean!)

    Indicates whether or not this location is used for calculating shipping rates.

  • suggestedAddresses ([LocationSuggestedAddress!]!)

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

Types that return Location

Implements

Deprecated fields

  • isPrimary (Boolean!) deprecated

    Whether the location is your primary location for shipping inventory.

    Deprecation warning

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

Version 2020-04

An auto-generated type for paginating through multiple Locations.

On this page

Fields

Version 2020-04

An auto-generated type which holds one Location and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • node (Location!)

    The item at the end of LocationEdge.

Types that return LocationEdge

Version 2020-01 (Unsupported)

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

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

    The name of the location.

  • shipsInventory (Boolean!)

    Indicates whether or not this location is used for calculating shipping rates.

  • suggestedAddresses ([LocationSuggestedAddress!]!)

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

Types that return Location

Implements

Deprecated fields

  • isPrimary (Boolean!) deprecated

    Whether the location is your primary location for shipping inventory.

    Deprecation warning

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

Version 2020-01 (Unsupported)

An auto-generated type for paginating through multiple Locations.

On this page

Fields

Version 2020-01 (Unsupported)

An auto-generated type which holds one Location and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • node (Location!)

    The item at the end of LocationEdge.

Types that return LocationEdge

Version 2019-10 (Unsupported)

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

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

    The name of the location.

  • shipsInventory (Boolean!)

    Indicates whether or not this location is used for calculating shipping rates.

  • suggestedAddresses ([LocationSuggestedAddress!]!)

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

Types that return Location

Implements

Deprecated fields

  • isPrimary (Boolean!) deprecated

    Whether the location is your primary location for shipping inventory.

    Deprecation warning

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

Version 2019-10 (Unsupported)

An auto-generated type for paginating through multiple Locations.

On this page

Fields

Version 2019-10 (Unsupported)

An auto-generated type which holds one Location and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • node (Location!)

    The item at the end of LocationEdge.

Types that return LocationEdge

Version 2019-07 (Unsupported)

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

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

    The name of the location.

  • shipsInventory (Boolean!)

    Indicates whether or not this location is used for calculating shipping rates.

  • suggestedAddresses ([LocationSuggestedAddress!]!)

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

Types that return Location

Implements

Deprecated fields

  • isPrimary (Boolean!) deprecated

    Whether the location is your primary location for shipping inventory.

    Deprecation warning

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

Version 2019-07 (Unsupported)

An auto-generated type for paginating through multiple Locations.

On this page

Fields

Version 2019-07 (Unsupported)

An auto-generated type which holds one Location and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • node (Location!)

    The item at the end of LocationEdge.

Types that return LocationEdge

Version 2019-04 (Unsupported)

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

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

    The name of the location.

  • shipsInventory (Boolean!)

    Indicates whether or not this location is used for calculating shipping rates.

  • suggestedAddresses ([LocationSuggestedAddress!]!)

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

Types that return Location

Implements

Deprecated fields

  • isPrimary (Boolean!) deprecated

    Whether the location is your primary location for shipping inventory.

    Deprecation warning

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

Version 2019-04 (Unsupported)

An auto-generated type for paginating through multiple Locations.

On this page

Fields

Version 2019-04 (Unsupported)

An auto-generated type which holds one Location and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • node (Location!)

    The item at the end of LocationEdge.

Types that return LocationEdge

Samples