younifyd
Menu

companyLocation

Fetch a single company location by its ID.

Use it in a workflow

  1. Add a step and choose the Shopify connector.
  2. Pick the companyLocation action (under Company).
  3. Fill in the fields below, then reference the result from later steps as {{companylocation.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 CompanyLocation($id: ID!) {
  companyLocation(id: $id) {
    billingAddress {
      address1
      address2
      city
      companyName
      country
      countryCode
      createdAt
      firstName
      formattedArea
      id
      lastName
      phone
      province
      recipient
      updatedAt
      zip
      zoneCode
    }
    buyerExperienceConfiguration {
      checkoutToDraft
      deposit
      editableShippingAddress
      payNowOnly
      paymentTermsTemplate {
        description
        dueInDays
        id
        name
        paymentTermsType
        translatedName
      }
    }
    company {
      contactCount
      contactsCount {
        count
        precision
      }
      createdAt
      customerSince
      defaultCursor
      defaultRole {
        id
        name
        note
      }
      externalId
      hasTimelineComment
      id
      lifetimeDuration
      locationsCount {
        count
        precision
      }
      mainContact {
        company
        createdAt
        customer
        id
        isMainContact
        lifetimeDuration
        locale
        title
        updatedAt
      }
      name
      note
      ordersCount {
        count
        precision
      }
      totalSpent {
        amount
        currencyCode
      }
      updatedAt
    }
    createdAt
    currency
    defaultCursor
    externalId
    hasTimelineComment
    id
    locale
    market {
      catalogsCount {
        count
        precision
      }
      conditions {
        channelsCondition
        companyLocationsCondition
        conditionTypes
        locationsCondition
        regionsCondition
      }
      currencySettings {
        baseCurrency
        localCurrencies
        roundingEnabled
      }
      delivery {
        shipping
      }
      discountsCount {
        count
        precision
      }
      enabled
      handle
      id
      name
      priceInclusions {
        adaptivePricingEnabled
        inclusiveDutiesPricingStrategy
        inclusiveTaxPricingStrategy
      }
      priceList {
        catalog
        currency
        fixedPricesCount
        id
        name
        parent
      }
      primary
      status
      type
      webPresence {
        alternateLocales
        defaultLocale
        domain
        id
        market
        rootUrls
        subfolderSuffix
      }
    }
    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
  }
}

Variables

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

idstringrequired

The ID of the `CompanyLocation` to return.

json
{
  "id": "string"
}

Response

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

billingAddressobject
address1string
address2string
citystring
companyNamestring
countrystring
countryCodestring

One ofAFAXALDZADAOAIAGARAMAWACAUATAZBSBHBDBBBYBEBZBJBMBTBOBABWBVBRIOBNBGBFBIKHCACVBQKY

createdAtstring
firstNamestring
formattedAreastring
idstring
lastNamestring
phonestring
provincestring
recipientstring
updatedAtstring
zipstring
zoneCodestring
buyerExperienceConfigurationobject
checkoutToDraftboolean
depositobject1 fields

This field can return one of several different object shapes — properties from every possible shape are shown together.

editableShippingAddressboolean
payNowOnlyboolean
paymentTermsTemplateobject6 fields
companyobject
contactCountnumber
contactsCountobject2 fields
createdAtstring
customerSincestring
defaultCursorstring
defaultRoleobject3 fields
externalIdstring
hasTimelineCommentboolean
idstring
lifetimeDurationstring
locationsCountobject2 fields
mainContactobject9 fields
namestring
notestring
ordersCountobject2 fields
totalSpentobject2 fields
updatedAtstring
createdAtstring
currencystring

One ofUSDEURGBPCADAFNALLDZDAOAARSAMDAWGAUDBBDAZNBDTBSDBHDBIFBYNBZDBMDBTNBAMBRLBOBBWPBNDBGNMMKKHRCVEKYDXAFCLPCNYCOPKMFCDFCRCHRK

defaultCursorstring
externalIdstring
hasTimelineCommentboolean
idstring
localestring
marketobject
catalogsCountobject2 fields
conditionsobject5 fields
currencySettingsobject3 fields
deliveryobject1 fields
discountsCountobject2 fields
enabledboolean
handlestring
idstring
namestring
priceInclusionsobject3 fields
priceListobject6 fields
primaryboolean
statusstring

One ofACTIVEDRAFT

typestring

One ofNONEREGIONLOCATIONCOMPANY_LOCATIONCHANNEL

webPresenceobject7 fields
namestring
notestring
orderCountnumber
ordersCountobject
countnumber
precisionstring

One ofEXACTAT_LEAST

phonestring
shippingAddressobject
address1string
address2string
citystring
companyNamestring
countrystring
countryCodestring

One ofAFAXALDZADAOAIAGARAMAWACAUATAZBSBHBDBBBYBEBZBJBMBTBOBABWBVBRIOBNBGBFBIKHCACVBQKY

createdAtstring
firstNamestring
formattedAreastring
idstring
lastNamestring
phonestring
provincestring
recipientstring
updatedAtstring
zipstring
zoneCodestring
taxExemptionsarray<string>
taxRegistrationIdstring
taxSettingsobject
taxExemptboolean
taxExemptionsarray<object>
taxRegistrationIdstring
totalSpentobject
amountstring
currencyCodestring

One ofUSDEURGBPCADAFNALLDZDAOAARSAMDAWGAUDBBDAZNBDTBSDBHDBIFBYNBZDBMDBTNBAMBRLBOBBWPBNDBGNMMKKHRCVEKYDXAFCLPCNYCOPKMFCDFCRCHRK

updatedAtstring

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

companyLocation — Shopify — Documentation