companyLocationAssignAddress
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 an address on a company location.

Anchor to section titled 'Arguments'

Arguments

Anchor to address address CompanyAddressInput! required: The input fields to use to update the address.
Anchor to addressTypes addressTypes [CompanyAddressType!]! required: The list of address types on the location to update.
Anchor to locationId locationId ID! required: The ID of the company location to update addresses on.

Was this section helpful?

Anchor to section titled 'CompanyLocationAssignAddressPayload returns'

CompanyLocationAssignAddressPayload returns

Anchor to CompanyLocationAssignAddressPayload.addresses addresses [CompanyAddress!]: The list of updated addresses on the company location.
Anchor to CompanyLocationAssignAddressPayload.userErrors userErrors [BusinessCustomerUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: companyLocationAssignAddress

Query Reference for MUTATION: companyLocationAssignAddress

"mutation companyLocationAssignAddress($address: CompanyAddressInput!, $addressTypes: [CompanyAddressType!]!, $locationId: ID!) {\n  companyLocationAssignAddress(address: $address, addressTypes: $addressTypes, locationId: $locationId) {\n    addresses {\n      # CompanyAddress fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: companyLocationAssignAddress

"{\n  \"address\": {\n    \"address1\": \"<your-address1>\",\n    \"address2\": \"<your-address2>\",\n    \"city\": \"<your-city>\",\n    \"countryCode\": \"AC\",\n    \"firstName\": \"<your-firstName>\",\n    \"lastName\": \"<your-lastName>\",\n    \"phone\": \"<your-phone>\",\n    \"recipient\": \"<your-recipient>\",\n    \"zip\": \"<your-zip>\",\n    \"zoneCode\": \"<your-zoneCode>\"\n  },\n  \"addressTypes\": [\n    \"BILLING\"\n  ],\n  \"locationId\": \"gid://shopify/<objectName>/10079785100\"\n}"

Schema Reference for MUTATION: companyLocationAssignAddress

"input CompanyAddressInput {\n  address1: String\n  address2: String\n  city: String\n  countryCode: CountryCode\n  firstName: String\n  lastName: String\n  phone: String\n  recipient: String\n  zip: String\n  zoneCode: String\n}\n"

Display Examples for MUTATION: companyLocationAssignAddress

[]

companyLocationAssignAddressmutation

Arguments

CompanyLocationAssignAddressPayload returns

companyLocationAssignAddress
mutation