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's information and B2B checkout settings. Company locations are branches or offices where CompanyContact members place orders on behalf of the company. Contacts must be assigned to a location through roleAssignments to place orders.

The mutation modifies details such as the location's name, contact information, preferred locale, and internal notes. You can also configure the B2B checkout experience through BuyerExperienceConfiguration settings that control whether orders require merchant review, PaymentTermsTemplate settings, shipping address editing permissions, and DepositConfiguration requirements.

Learn more about managing company locations.

Anchor to Arguments

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?

Examples

companyLocationUpdate reference

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": {

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

"phone": "<your-phone>",

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

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

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

"buyerExperienceConfiguration": {

"checkoutToDraft": true,

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

"editableShippingAddress": true,

"deposit": {}

}

Variables

{
  "companyLocationId": "gid://shopify/<objectName>/10079785100",
  "input": {
    "name": "<your-name>",
    "phone": "<your-phone>",
    "locale": "<your-locale>",
    "externalId": "<your-externalId>",
    "note": "<your-note>",
    "buyerExperienceConfiguration": {
      "checkoutToDraft": true,
      "paymentTermsTemplateId": "gid://shopify/<objectName>/10079785100",
      "editableShippingAddress": true,
      "deposit": {}
    }
  }
}

Schema

input CompanyLocationUpdateInput {
  name: String
  phone: String
  locale: String
  externalId: String
  note: String
  buyerExperienceConfiguration: BuyerExperienceConfigurationInput
}

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