companyLocationUpdate
mutation

Choose a version:

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?

Code examples for MUTATION: companyLocationUpdate

Query Reference for MUTATION: companyLocationUpdate

"mutation companyLocationUpdate($companyLocationId: ID!, $input: CompanyLocationUpdateInput!) {\n  companyLocationUpdate(companyLocationId: $companyLocationId, input: $input) {\n    companyLocation {\n      # CompanyLocation fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: companyLocationUpdate

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

Schema Reference for MUTATION: companyLocationUpdate

"input CompanyLocationUpdateInput {\n  buyerExperienceConfiguration: BuyerExperienceConfigurationInput\n  externalId: String\n  locale: String\n  name: String\n  note: String\n  phone: String\n}\n\ninput BuyerExperienceConfigurationInput {\n  checkoutToDraft: Boolean\n  deposit: DepositInput\n  editableShippingAddress: Boolean\n  paymentTermsTemplateId: ID\n}\n"

Display Examples for MUTATION: companyLocationUpdate

[]

companyLocationUpdatemutation

Arguments

CompanyLocationUpdatePayload returns

companyLocationUpdate
mutation