Anchor to section titled 'undefined'

companyLocationUpdate
mutation

Requires write_customers access scope or write_companies access scope. Also: The API client must be installed on a Shopify Plus store.

Updates a company location.

Anchor to section titled 'Arguments'

Arguments

Anchor to companyLocationId
companyLocationId
ID!
required

The ID of the company location to update.

Anchor to input
input
CompanyLocationUpdateInput!
required

The input fields to update in the company location.

Was this section helpful?
Anchor to section titled 'CompanyLocationUpdatePayload returns'

CompanyLocationUpdatePayload returns

Anchor to CompanyLocationUpdatePayload.companyLocation
companyLocation
CompanyLocation

The updated company location.

Anchor to CompanyLocationUpdatePayload.userErrors
userErrors
[BusinessCustomerUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?
Hide code
Mutation reference
Copy
mutation companyLocationUpdate($companyLocationId: ID!, $input: CompanyLocationUpdateInput!) {
  companyLocationUpdate(companyLocationId: $companyLocationId, input: $input) {
    companyLocation {
      # CompanyLocation fields
    }
    userErrors {
      field
      message
    }
  }
}
Hide code
Input
Copy
{
  "companyLocationId": "gid://shopify/<objectName>/10079785100",
  "input": {
    "buyerExperienceConfiguration": {
      "checkoutToDraft": true,
      "editableShippingAddress": true,
      "paymentTermsTemplateId": "gid://shopify/<objectName>/10079785100"
    },
    "externalId": "<your-externalId>",
    "locale": "<your-locale>",
    "name": "<your-name>",
    "note": "<your-note>",
    "phone": "<your-phone>"
  }
}
input CompanyLocationUpdateInput {
  buyerExperienceConfiguration: BuyerExperienceConfigurationInput
  externalId: String
  locale: String
  name: String
  note: String
  phone: String
}

input BuyerExperienceConfigurationInput {
  checkoutToDraft: Boolean
  editableShippingAddress: Boolean
  paymentTermsTemplateId: ID
}