locations

Returns shop locations that support in-store pickup. Use the near argument with GeoCoordinateInput to sort results by proximity to the customer's location.

Use it in a workflow

Add a step and choose the Shopify Storefront 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($first: Int, $after: String, $last: Int, $before: String, $reverse: Boolean, $sortKey: LocationSortKeys, $near: GeoCoordinateInput) {
  locations(
    first: $first
    after: $after
    last: $last
    before: $before
    reverse: $reverse
    sortKey: $sortKey
    near: $near
  ) {
    edges {
      cursor
      node {
        address
        id
        name
      }
    }
    nodes {
      address {
        address1
        address2
        city
        country
        countryCode
        formatted
        latitude
        longitude
        phone
        province
        provinceCode
        zip
      }
      id
      name
    }
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
  }
}

Variables

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

firstnumber

Returns up to the first `n` elements from the list.

afterstring

Returns the elements that come after the specified cursor.

lastnumber

Returns up to the last `n` elements from the list.

beforestring

Returns the elements that come before the specified cursor.

reverseboolean

Reverse the order of the underlying list.

sortKeystring

Sort the underlying list by the given key.

One ofIDNAMECITYDISTANCE

nearobject

Used to sort results based on proximity to the provided location.

latitudenumberrequired

longitudenumberrequired

json

{
  "first": 0,
  "after": "string",
  "last": 0,
  "before": "string",
  "reverse": false,
  "sortKey": "ID",
  "near": {
    "latitude": 0,
    "longitude": 0
  }
}

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>

addressobject

idobject

nameobject

pageInfoobject

endCursorstring

hasNextPageboolean

hasPreviousPageboolean

startCursorstring

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

Was this page helpful?