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

DeliveryLocationGroup object

Version unstable

A location group is a collection of active locations that share zone and delivery methods across delivery profiles.

Connections

  • locations (LocationConnection!)

    List of active locations that are part of this location group.

    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.

    includeInactive ( Boolean )

    If true, also include the locations that are deactivated.
    Default value: false

    includeLegacy ( Boolean )

    If true, also include the legacy locations of fulfillment services.
    Default value: false

    last ( Int )

    Returns up to the last n elements from the list.

    query ( String )

    Supported filter parameters:

    • active
    • address1
    • address2
    • city
    • country
    • legacy
    • name
    • province
    • zip

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

    reverse ( Boolean )

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

    sortKey ( LocationSortKeys )

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

Fields

  • id (ID!)

    Globally unique identifier.

Types that return DeliveryLocationGroup

Implements

Version 2021-04 (Release candidate)

A location group is a collection of active locations that share zone and delivery methods across delivery profiles.

Connections

  • locations (LocationConnection!)

    List of active locations that are part of this location group.

    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.

    includeInactive ( Boolean )

    If true, also include the locations that are deactivated.
    Default value: false

    includeLegacy ( Boolean )

    If true, also include the legacy locations of fulfillment services.
    Default value: false

    last ( Int )

    Returns up to the last n elements from the list.

    query ( String )

    Supported filter parameters:

    • active
    • address1
    • address2
    • city
    • country
    • legacy
    • name
    • province
    • zip

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

    reverse ( Boolean )

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

    sortKey ( LocationSortKeys )

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

Fields

  • id (ID!)

    Globally unique identifier.

Types that return DeliveryLocationGroup

Implements

Version 2021-01 (Latest)

A location group is a collection of active locations that share zone and delivery methods across delivery profiles.

Connections

  • locations (LocationConnection!)

    List of active locations that are part of this location group.

    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.

    includeInactive ( Boolean )

    If true, also include the locations that are deactivated.
    Default value: false

    includeLegacy ( Boolean )

    If true, also include the legacy locations of fulfillment services.
    Default value: false

    last ( Int )

    Returns up to the last n elements from the list.

    query ( String )

    Supported filter parameters:

    • active
    • address1
    • address2
    • city
    • country
    • legacy
    • name
    • province
    • zip

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

    reverse ( Boolean )

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

    sortKey ( LocationSortKeys )

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

Fields

  • id (ID!)

    Globally unique identifier.

Types that return DeliveryLocationGroup

Implements

Version 2020-10

A location group is a collection of active locations that share zone and delivery methods across delivery profiles.

Connections

  • locations (LocationConnection!)

    List of active locations that are part of this location group.

    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.

    includeInactive ( Boolean )

    If true, also include the locations that are deactivated.
    Default value: false

    includeLegacy ( Boolean )

    If true, also include the legacy locations of fulfillment services.
    Default value: false

    last ( Int )

    Returns up to the last n elements from the list.

    query ( String )

    Supported filter parameters:

    • active
    • address1
    • address2
    • city
    • country
    • legacy
    • name
    • province
    • zip

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

    reverse ( Boolean )

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

    sortKey ( LocationSortKeys )

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

Fields

  • id (ID!)

    Globally unique identifier.

Types that return DeliveryLocationGroup

Implements

Version 2020-07

A location group is a collection of active locations that share zone and delivery methods across delivery profiles.

Connections

  • locations (LocationConnection!)

    List of active locations that are part of this location group.

    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.

    includeInactive ( Boolean )

    If true, also include the locations that are deactivated.
    Default value: false

    includeLegacy ( Boolean )

    If true, also include the legacy locations of fulfillment services.
    Default value: false

    last ( Int )

    Returns up to the last n elements from the list.

    query ( String )

    Supported filter parameters:

    • active
    • address1
    • address2
    • city
    • country
    • legacy
    • name
    • province
    • zip

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

    reverse ( Boolean )

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

    sortKey ( LocationSortKeys )

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

Fields

  • id (ID!)

    Globally unique identifier.

Types that return DeliveryLocationGroup

Implements

Version 2020-04

A location group is a collection of active locations that share zone and delivery methods across delivery profiles.

Connections

  • locations (LocationConnection!)

    List of active locations that are part of this location group.

    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.

    includeInactive ( Boolean )

    If true, also include the locations that are deactivated.
    Default value: false

    includeLegacy ( Boolean )

    If true, also include the legacy locations of fulfillment services.
    Default value: false

    last ( Int )

    Returns up to the last n elements from the list.

    query ( String )

    Supported filter parameters:

    • active
    • address1
    • address2
    • city
    • country
    • legacy
    • name
    • province
    • zip

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

    reverse ( Boolean )

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

    sortKey ( LocationSortKeys )

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

Fields

  • id (ID!)

    Globally unique identifier.

Types that return DeliveryLocationGroup

Implements

Version 2020-01 (Unsupported)

A location group is a collection of active locations that share zone and delivery methods across delivery profiles.

Connections

  • locations (LocationConnection!)

    List of active locations that are part of this location group.

    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.

    includeInactive ( Boolean )

    If true, also include the locations that are deactivated.
    Default value: false

    includeLegacy ( Boolean )

    If true, also include the legacy locations of fulfillment services.
    Default value: false

    last ( Int )

    Returns up to the last n elements from the list.

    query ( String )

    Supported filter parameters:

    • active
    • address1
    • address2
    • city
    • country
    • legacy
    • name
    • province
    • zip

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

    reverse ( Boolean )

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

    sortKey ( LocationSortKeys )

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

Fields

  • id (ID!)

    Globally unique identifier.

Types that return DeliveryLocationGroup

Implements

Version 2019-10 (Unsupported)

A location group is a collection of active locations that share zone and delivery methods across delivery profiles.

Connections

  • locations (LocationConnection!)

    List of active locations that are part of this location group.

    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.

    includeInactive ( Boolean )

    If true, also include the locations that are deactivated.
    Default value: false

    includeLegacy ( Boolean )

    If true, also include the legacy locations of fulfillment services.
    Default value: false

    last ( Int )

    Returns up to the last n elements from the list.

    query ( String )

    Supported filter parameters:

    • active
    • address1
    • address2
    • city
    • country
    • legacy
    • name
    • province
    • zip

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

    reverse ( Boolean )

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

    sortKey ( LocationSortKeys )

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

Fields

  • id (ID!)

    Globally unique identifier.

Types that return DeliveryLocationGroup

Implements

Version 2019-07 (Unsupported)

A location group is a collection of active locations that share zone and delivery methods across delivery profiles.

Connections

  • locations (LocationConnection!)

    List of active locations that are part of this location group.

    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.

    includeInactive ( Boolean )

    If true, also include the locations that are deactivated.
    Default value: false

    includeLegacy ( Boolean )

    If true, also include the legacy locations of fulfillment services.
    Default value: false

    last ( Int )

    Returns up to the last n elements from the list.

    query ( String )

    Supported filter parameters:

    • active
    • address1
    • address2
    • city
    • country
    • legacy
    • name
    • province
    • zip

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

    reverse ( Boolean )

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

    sortKey ( LocationSortKeys )

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

Fields

  • id (ID!)

    Globally unique identifier.

Types that return DeliveryLocationGroup

Implements

Version 2019-04 (Unsupported)

A location group is a collection of active locations that share zone and delivery methods across delivery profiles.

Connections

  • locations (LocationConnection!)

    List of active locations that are part of this location group.

    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.

    includeInactive ( Boolean )

    If true, also include the locations that are deactivated.
    Default value: false

    includeLegacy ( Boolean )

    If true, also include the legacy locations of fulfillment services.
    Default value: false

    last ( Int )

    Returns up to the last n elements from the list.

    query ( String )

    Supported filter parameters:

    • active
    • address1
    • address2
    • city
    • country
    • legacy
    • name
    • province
    • zip

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

    reverse ( Boolean )

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

    sortKey ( LocationSortKeys )

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

Fields

  • id (ID!)

    Globally unique identifier.

Types that return DeliveryLocationGroup

Implements

Samples