Choose a version:

CompanyLocation

object

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

A location or branch of a company that's a customer of the shop. Configuration of B2B relationship, for example prices lists and checkout settings, may be done for a location.

Anchor to Fields and connectionsFields and connections

Anchor to billingAddressbillingAddress •CompanyAddress: The address used as billing address for the location.
Anchor to buyerExperienceConfigurationbuyerExperienceConfiguration •BuyerExperienceConfiguration: The configuration for the buyer's B2B checkout.
Anchor to catalogscatalogs •CatalogConnection!non-null: The list of catalogs associated with the company location.
Anchor to catalogsCountcatalogsCount •Count: The number of catalogs associated with the company location. Limited to a maximum of 10000.
Anchor to companycompany •Company!non-null: The company that the company location belongs to.
Anchor to createdAtcreatedAt •DateTime!non-null: The date and time (ISO 8601 format) at which the company location was created in Shopify.
Anchor to currencycurrency •CurrencyCode!non-null: The location's currency based on the shipping address. If the shipping address is empty, then the value is the shop's primary market.
Anchor to defaultCursordefaultCursor •String!non-null: A default cursor that returns the single next record, sorted ascending by ID.
Anchor to draftOrdersdraftOrders •DraftOrderConnection!non-null: The list of draft orders for the company location.
Anchor to eventsevents •EventConnection!non-null: The paginated list of events associated with the host subject.
Anchor to externalIdexternalId •String: A unique externally-supplied ID for the company location.
Anchor to hasTimelineCommenthasTimelineComment •Boolean!non-null: Whether the merchant added a timeline comment to the company location.
Anchor to idid •ID!non-null: A globally-unique ID.
Anchor to inCataloginCatalog •Boolean!non-null: Whether the company location is assigned a specific catalog.
Anchor to localelocale •String: The preferred locale of the company location.
Anchor to marketmarket •Market!non-null: The market that includes the location's shipping address. If the shipping address is empty, then the value is the shop's primary market.
Anchor to metafieldmetafield •Metafield: A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.
Anchor to metafieldsmetafields •MetafieldConnection!non-null: A list of custom fields that a merchant associates with a Shopify resource.
Anchor to namename •String!non-null: The name of the company location.
Anchor to notenote •String: A note about the company location.
Anchor to ordersorders •OrderConnection!non-null: The list of orders for the company location.
Anchor to ordersCountordersCount •Count: The total number of orders placed for the location.
Anchor to phonephone •String: The phone number of the company location.
Anchor to roleAssignmentsroleAssignments •CompanyContactRoleAssignmentConnection!non-null: The list of roles assigned to the company location.
Anchor to shippingAddressshippingAddress •CompanyAddress: The address used as shipping address for the location.
Anchor to staffMemberAssignmentsstaffMemberAssignments •CompanyLocationStaffMemberAssignmentConnection!non-null: The list of staff members assigned to the company location.
Anchor to taxSettingstaxSettings •CompanyLocationTaxSettings!non-null: The tax settings for the company location.
Anchor to totalSpenttotalSpent •MoneyV2!non-null: The total amount spent by the location.
Anchor to updatedAtupdatedAt •DateTime!non-null: The date and time (ISO 8601 format) at which the company location was last modified.

Deprecated fields and connections

Anchor to metafieldDefinitionsmetafieldDefinitions •MetafieldDefinitionConnection!non-nullDeprecated
Anchor to orderCountorderCount •Int!non-nullDeprecated
Anchor to taxExemptionstaxExemptions •[TaxExemption!]!non-nullDeprecated
Anchor to taxRegistrationIdtaxRegistrationId •StringDeprecated

Was this section helpful?

Anchor to QueriesQueries

Anchor to companyLocation companyLocation •query: Returns a CompanyLocation object by ID.
Anchor to companyLocations companyLocations •query: Returns the list of company locations in the shop.

Was this section helpful?

Anchor to MutationsMutations

companyLocationCreate

•mutation

Creates a company location.

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.

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

companyLocationTaxSettingsUpdate

•mutation

Sets the tax settings for a company location.

Anchor to companyLocationIdcompanyLocationId •ID!required: The ID of the company location that the tax settings get assigned to.
Anchor to exemptionsToAssignexemptionsToAssign •[TaxExemption!]: The list of tax exemptions to assign to the company location.
Anchor to exemptionsToRemoveexemptionsToRemove •[TaxExemption!]: The list of tax exemptions to remove from the company location.
Anchor to taxExempttaxExempt •Boolean: Whether the location is exempt from taxes.
Anchor to taxRegistrationIdtaxRegistrationId •String: The unique tax registration ID for the company location.

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

companyLocationUpdate

•mutation

Updates a company location.

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.

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