Choose a version:

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.

Arguments

Anchor to companyLocationIdcompanyLocationId •ID! required: The ID of the company location to update.
Anchor to inputinput •CompanyLocationUpdateInput! required: The input fields to update in the company location.

Was this section helpful?

Anchor to CompanyLocationUpdatePayload returnsCompanyLocationUpdatePayload returns

Anchor to companyLocationcompanyLocation •CompanyLocation: The updated company location.
Anchor to userErrorsuserErrors •[BusinessCustomerUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Mutation Reference

mutation companyLocationUpdate($companyLocationId: ID!, $input: CompanyLocationUpdateInput!) {

companyLocationUpdate(companyLocationId: $companyLocationId, input: $input) {

companyLocation {

# CompanyLocation fields

}

userErrors {

field

message

}

Input

{

"companyLocationId": "gid://shopify/<objectName>/10079785100",

"input": {

"buyerExperienceConfiguration": {

"checkoutToDraft": true,

"deposit": "",

"editableShippingAddress": true,

"paymentTermsTemplateId": "gid://shopify/<objectName>/10079785100"

"externalId": "<your-externalId>",

"locale": "<your-locale>",

"name": "<your-name>",

"note": "<your-note>",

"phone": "<your-phone>"

}

{
  "companyLocationId": "gid://shopify/<objectName>/10079785100",
  "input": {
    "buyerExperienceConfiguration": {
      "checkoutToDraft": true,
      "deposit": "",
      "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
  deposit: DepositInput
  editableShippingAddress: Boolean
  paymentTermsTemplateId: ID
}