locations

A paginated list of inventory locations where merchants can stock Product items and fulfill Order items.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the locations action (under Locations).
Fill in the fields below, then reference the result from later steps as {{locations.response.data}}.

Query

This is the query the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

query Locations($includeLegacy: Boolean, $includeInactive: Boolean, $first: Int, $after: String, $last: Int, $before: String, $reverse: Boolean, $sortKey: LocationSortKeys, $query: String) {
  locations(
    includeLegacy: $includeLegacy
    includeInactive: $includeInactive
    first: $first
    after: $after
    last: $last
    before: $before
    reverse: $reverse
    sortKey: $sortKey
    query: $query
  ) {
    edges {
      cursor
      node {
        activatable
        address
        addressVerified
        createdAt
        deactivatable
        deactivatedAt
        deletable
        fulfillmentService
        fulfillsOnlineOrders
        hasActiveInventory
        hasUnfulfilledOrders
        id
        isActive
        isFulfillmentService
        isPrimary
        legacyResourceId
        localPickupSettingsV2
        name
        shipsInventory
        suggestedAddresses
        updatedAt
      }
    }
    nodes {
      activatable
      address {
        address1
        address2
        city
        country
        countryCode
        formatted
        latitude
        longitude
        phone
        province
        provinceCode
        zip
      }
      addressVerified
      createdAt
      deactivatable
      deactivatedAt
      deletable
      fulfillmentService {
        callbackUrl
        fulfillmentOrdersOptIn
        handle
        id
        inventoryManagement
        location
        requiresShippingMethod
        serviceName
        trackingSupport
        type
      }
      fulfillsOnlineOrders
      hasActiveInventory
      hasUnfulfilledOrders
      id
      isActive
      isFulfillmentService
      isPrimary
      legacyResourceId
      localPickupSettingsV2 {
        instructions
        pickupTime
      }
      name
      shipsInventory
      suggestedAddresses {
        address1
        address2
        city
        country
        countryCode
        formatted
        province
        provinceCode
        zip
      }
      updatedAt
    }
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

includeLegacyboolean

Whether to include the legacy locations of fulfillment services.

includeInactiveboolean

Whether to include the locations that are deactivated.

firstnumber

The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

afterstring

The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

lastnumber

The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

beforestring

The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

reverseboolean

Reverse the order of the underlying list.

sortKeystring

Sort the underlying list using a key. If your query is slow or returns an error, then [try specifying a sort key that matches the field used in the search](https://shopify.dev/api/usage/pagination-graphql#search-performance-considerations).

One ofIDNAMERELEVANCE

querystring

A filter made up of terms, connectives, modifiers, and comparators. | name | type | description | acceptable_values | default_value | example_use | | ---- | ---- | ---- | ---- | ---- | ---- | | default | string | Filter by a case-insensitive search of multiple fields in a document. | | | - `query=Bob Norman`<br/> - `query=title:green hoodie` | | active | string | | address1 | string | | address2 | string | | city | string | | country | string | | created_at | time | | geolocated | boolean | | id | id | Filter by `id` range. | | | - `id:1234`<br/> - `id:>=1234`<br/> - `id:<=1234` | | legacy | boolean | | location_id | id | | name | string | | pickup_in_store | string | | - `enabled`<br/> - `disabled` | | province | string | | zip | string | You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax).

json

{
  "includeLegacy": false,
  "includeInactive": false,
  "first": 0,
  "after": "string",
  "last": 0,
  "before": "string",
  "reverse": false,
  "sortKey": "ID",
  "query": "string"
}

Response

Read the result with {{locations.response.data.data.locations}}. If the API returns errors, the step fails and they are at {{locations.response.data.errors}}.

edgesarray<object>

cursorobject

nodeobject

nodesarray<object>

activatableobject

addressobject

addressVerifiedobject

createdAtobject

deactivatableobject

deactivatedAtobject

deletableobject

fulfillmentServiceobject

fulfillsOnlineOrdersobject

hasActiveInventoryobject

hasUnfulfilledOrdersobject

idobject

isActiveobject

isFulfillmentServiceobject

isPrimaryobject

legacyResourceIdobject

localPickupSettingsV2object

nameobject

shipsInventoryobject

suggestedAddressesobject

updatedAtobject

pageInfoobject

endCursorstring

hasNextPageboolean

hasPreviousPageboolean

startCursorstring

Need more? See the Shopify guide for connection setup and behaviour shared by every action.

Was this page helpful?