Choose a version:

companyLocationCreate

mutation

Requires write_customers access scope or write_companies access scope. Also: The API client must be installed on a Shopify Plus store.

Creates a new location for a Company. Company locations are branches or offices where B2B customers can place orders with specific pricing, catalogs, and payment terms.

Creates a company location. Each location can have its own billing and shipping addresses, tax settings, and buyer experience configuration. You can assign staff members and CompanyContact objects to manage the location.

Anchor to Arguments

Arguments

Anchor to companyIdcompanyId

•ID!

required

The ID of the company that the company location belongs to.

Anchor to inputinput

•CompanyLocationInput!

required

The fields to use to create the company location.

Was this section helpful?

Anchor to CompanyLocationCreatePayload returnsCompanyLocationCreatePayload returns

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

Was this section helpful?

Examples

companyLocationCreate reference

Mutation Reference

mutation companyLocationCreate($companyId: ID!, $input: CompanyLocationInput!) {

companyLocationCreate(companyId: $companyId, input: $input) {

companyLocation {

# CompanyLocation fields

}

userErrors {

field

message

}

Input

{

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

"billingAddress": {

"address1": "<your-address1>",

"address2": "<your-address2>",

"city": "<your-city>",

"zip": "<your-zip>",

"recipient": "<your-recipient>",

"firstName": "<your-firstName>",

"lastName": "<your-lastName>",

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

"zoneCode": "<your-zoneCode>",

"countryCode": "AF"

"shippingAddress": {

"address1": "<your-address1>",

"address2": "<your-address2>",

"city": "<your-city>",

"zip": "<your-zip>",

"recipient": "<your-recipient>",

"firstName": "<your-firstName>",

"lastName": "<your-lastName>",

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

"zoneCode": "<your-zoneCode>",

"countryCode": "AF"

"billingSameAsShipping": true,

"taxRegistrationId": "<your-taxRegistrationId>",

"taxExemptions": [

"CA_STATUS_CARD_EXEMPTION"

"taxExempt": true

}

Variables

{
  "companyId": "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": {}
    },
    "billingAddress": {
      "address1": "<your-address1>",
      "address2": "<your-address2>",
      "city": "<your-city>",
      "zip": "<your-zip>",
      "recipient": "<your-recipient>",
      "firstName": "<your-firstName>",
      "lastName": "<your-lastName>",
      "phone": "<your-phone>",
      "zoneCode": "<your-zoneCode>",
      "countryCode": "AF"
    },
    "shippingAddress": {
      "address1": "<your-address1>",
      "address2": "<your-address2>",
      "city": "<your-city>",
      "zip": "<your-zip>",
      "recipient": "<your-recipient>",
      "firstName": "<your-firstName>",
      "lastName": "<your-lastName>",
      "phone": "<your-phone>",
      "zoneCode": "<your-zoneCode>",
      "countryCode": "AF"
    },
    "billingSameAsShipping": true,
    "taxRegistrationId": "<your-taxRegistrationId>",
    "taxExemptions": [
      "CA_STATUS_CARD_EXEMPTION"
    ],
    "taxExempt": true
  }
}

Schema

input CompanyLocationInput {
  name: String
  phone: String
  locale: String
  externalId: String
  note: String
  buyerExperienceConfiguration: BuyerExperienceConfigurationInput
  billingAddress: CompanyAddressInput
  shippingAddress: CompanyAddressInput
  billingSameAsShipping: Boolean
  taxRegistrationId: String
  taxExemptions: [TaxExemption!]
  taxExempt: Boolean
}

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

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