companyLocations

A paginated list of CompanyLocation objects for B2B customers. Company locations represent individual branches or offices of a Company where B2B orders can be placed.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the companyLocations action (under Company).
Fill in the fields below, then reference the result from later steps as {{companylocations.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 CompanyLocations($first: Int, $after: String, $last: Int, $before: String, $reverse: Boolean, $sortKey: CompanyLocationSortKeys, $query: String) {
  companyLocations(
    first: $first
    after: $after
    last: $last
    before: $before
    reverse: $reverse
    sortKey: $sortKey
    query: $query
  ) {
    edges {
      cursor
      node {
        billingAddress
        buyerExperienceConfiguration
        company
        createdAt
        currency
        defaultCursor
        externalId
        hasTimelineComment
        id
        locale
        market
        name
        note
        orderCount
        ordersCount
        phone
        shippingAddress
        taxExemptions
        taxRegistrationId
        taxSettings
        totalSpent
        updatedAt
      }
    }
    nodes {
      billingAddress {
        address1
        address2
        city
        companyName
        country
        countryCode
        createdAt
        firstName
        formattedArea
        id
        lastName
        phone
        province
        recipient
        updatedAt
        zip
        zoneCode
      }
      buyerExperienceConfiguration {
        checkoutToDraft
        deposit
        editableShippingAddress
        payNowOnly
        paymentTermsTemplate
      }
      company {
        contactCount
        contactsCount
        createdAt
        customerSince
        defaultCursor
        defaultRole
        externalId
        hasTimelineComment
        id
        lifetimeDuration
        locationsCount
        mainContact
        name
        note
        ordersCount
        totalSpent
        updatedAt
      }
      createdAt
      currency
      defaultCursor
      externalId
      hasTimelineComment
      id
      locale
      market {
        catalogsCount
        conditions
        currencySettings
        delivery
        discountsCount
        enabled
        handle
        id
        name
        priceInclusions
        priceList
        primary
        status
        type
        webPresence
      }
      name
      note
      orderCount
      ordersCount {
        count
        precision
      }
      phone
      shippingAddress {
        address1
        address2
        city
        companyName
        country
        countryCode
        createdAt
        firstName
        formattedArea
        id
        lastName
        phone
        province
        recipient
        updatedAt
        zip
        zoneCode
      }
      taxExemptions
      taxRegistrationId
      taxSettings {
        taxExempt
        taxExemptions
        taxRegistrationId
      }
      totalSpent {
        amount
        currencyCode
      }
      updatedAt
    }
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
  }
}

Variables

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

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 by the given key.

One ofCOMPANY_AND_LOCATION_NAMECOMPANY_IDCREATED_ATIDNAMERELEVANCEUPDATED_AT

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` | | company_id | id | | created_at | time | | external_id | string | | id | id | Filter by `id` range. | | | - `id:1234`<br/> - `id:>=1234`<br/> - `id:<=1234` | | ids | string | | metafields.{namespace}.{key} | mixed | Filters resources by metafield value. Format: `metafields.{namespace}.{key}:{value}`. Learn more about [querying by metafield value](https://shopify.dev/apps/build/custom-data/metafields/query-by-metafield-value). | | | - `metafields.custom.on_sale:true`<br/> - `metafields.product.material:"gid://shopify/Metaobject/43458085"` | | name | string | | updated_at | time | 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

{
  "first": 0,
  "after": "string",
  "last": 0,
  "before": "string",
  "reverse": false,
  "sortKey": "COMPANY_AND_LOCATION_NAME",
  "query": "string"
}

Response

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

edgesarray<object>

cursorobject

nodeobject

nodesarray<object>

billingAddressobject

buyerExperienceConfigurationobject

companyobject

createdAtobject

currencyobject

defaultCursorobject

externalIdobject

hasTimelineCommentobject

idobject

localeobject

marketobject

nameobject

noteobject

orderCountobject

ordersCountobject

phoneobject

shippingAddressobject

taxExemptionsobject

taxRegistrationIdobject

taxSettingsobject

totalSpentobject

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?