companyLocationCreate
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.

Creates a company location.

Anchor to section titled 'Arguments'

Arguments

Anchor to companyId companyId ID! required: The ID of the company that the company location belongs to.
Anchor to input input CompanyLocationInput! required: The fields to use to create the company location.

Was this section helpful?

Anchor to section titled 'CompanyLocationCreatePayload returns'

CompanyLocationCreatePayload returns

Anchor to CompanyLocationCreatePayload.companyLocation companyLocation CompanyLocation: The created company location.
Anchor to CompanyLocationCreatePayload.userErrors userErrors [BusinessCustomerUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: companyLocationCreate

Query Reference for MUTATION: companyLocationCreate

"mutation companyLocationCreate($companyId: ID!, $input: CompanyLocationInput!) {\n  companyLocationCreate(companyId: $companyId, input: $input) {\n    companyLocation {\n      # CompanyLocation fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: companyLocationCreate

"{\n  \"companyId\": \"gid://shopify/<objectName>/10079785100\",\n  \"input\": {\n    \"billingAddress\": {\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    \"billingSameAsShipping\": true,\n    \"buyerExperienceConfiguration\": {\n      \"checkoutToDraft\": true,\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    \"shippingAddress\": {\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    \"taxExemptions\": [\n      \"CA_BC_COMMERCIAL_FISHERY_EXEMPTION\"\n    ],\n    \"taxRegistrationId\": \"<your-taxRegistrationId>\"\n  }\n}"

Schema Reference for MUTATION: companyLocationCreate

"input CompanyLocationInput {\n  billingAddress: CompanyAddressInput\n  billingSameAsShipping: Boolean\n  buyerExperienceConfiguration: BuyerExperienceConfigurationInput\n  externalId: String\n  locale: String\n  name: String\n  note: String\n  phone: String\n  shippingAddress: CompanyAddressInput\n  taxExemptions: [TaxExemption!]\n  taxRegistrationId: String\n}\n\ninput 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\ninput BuyerExperienceConfigurationInput {\n  checkoutToDraft: Boolean\n  editableShippingAddress: Boolean\n  paymentTermsTemplateId: ID\n}\n"

Display Examples for MUTATION: companyLocationCreate

[]

companyLocationCreatemutation

Arguments

CompanyLocationCreatePayload returns

companyLocationCreate
mutation