companyLocationUpdate

Updates a company location's information and B2B checkout settings. Company locations are branches or offices where CompanyContact members place orders on behalf of the company.

Use it in a workflow

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

Query

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

graphql

mutation CompanyLocationUpdate($companyLocationId: ID!, $input: CompanyLocationUpdateInput!) {
  companyLocationUpdate(companyLocationId: $companyLocationId, input: $input) {
    companyLocation {
      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
    }
    userErrors {
      code
      field
      message
    }
  }
}

Variables

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

companyLocationIdstringrequired

The ID of the company location to update.

inputobjectrequired

The input fields to update in the company location.

namestring

phonestring

localestring

externalIdstring

notestring

buyerExperienceConfigurationobject4 fields

json

{
  "companyLocationId": "string",
  "input": {
    "name": "string",
    "phone": "string",
    "locale": "string",
    "externalId": "string",
    "note": "string",
    "buyerExperienceConfiguration": {
      "checkoutToDraft": false,
      "paymentTermsTemplateId": "string",
      "editableShippingAddress": false,
      "deposit": {
        "percentage": "string"
      }
    }
  }
}

Response

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

companyLocationobject

billingAddressobject17 fields

buyerExperienceConfigurationobject5 fields

companyobject17 fields

createdAtstring

currencystring

One ofUSDEURGBPCADAFNALLDZDAOAARSAMDAWGAUDBBDAZNBDTBSDBHDBIFBYNBZDBMDBTNBAMBRLBOBBWPBNDBGNMMKKHRCVEKYDXAFCLPCNYCOPKMFCDFCRCHRK

defaultCursorstring

externalIdstring

hasTimelineCommentboolean

idstring

localestring

marketobject15 fields

namestring

notestring

orderCountnumber

ordersCountobject2 fields

phonestring

shippingAddressobject17 fields

taxExemptionsarray<object>

taxRegistrationIdstring

taxSettingsobject3 fields

totalSpentobject2 fields

updatedAtstring

userErrorsarray<object>

codeobject

fieldobject

messageobject

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

Was this page helpful?