Skip to main content
Anchor to CompanyLocation

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. Company locations enable B2B customers to manage multiple branches with distinct billing and shipping addresses, tax settings, and checkout configurations.

Each location can have its own Catalog objects that determine which products are published and their pricing. The BuyerExperienceConfiguration determines checkout behavior including PaymentTerms, and whether orders require merchant review. B2B customers select which location they're purchasing for, which determines the applicable catalogs, pricing, TaxExemption values, and checkout settings for their Order objects.

Anchor to FieldsFields

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 by default.

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 hasPriceListhasPriceList
•Boolean!
non-null

Whether the company location has a price list with the specified ID.

Arguments

Anchor to priceListIdpriceListId
•ID!
required

The price list ID to check.

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.

Arguments

Anchor to catalogIdcatalogId
•ID!
required

The ID of the catalog.

Anchor to localelocale
•String

The preferred locale of the company location.

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 metafieldsByIdentifiersmetafieldsByIdentifiers
•[Metafield]!
non-null

The metafields associated with the resource matching the supplied list of namespaces and keys.

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 priceListspriceLists
•PriceListConnection!
non-null

The list of price lists for 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 storeCreditAccountsstoreCreditAccounts
•StoreCreditAccountConnection!
non-null

Returns a list of store credit accounts that belong to the owner resource. A store credit account owner can hold multiple accounts each with a different currency.

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

Anchor to marketmarket
•Market!
non-nullDeprecated
Anchor to metafieldDefinitionsmetafieldDefinitions
•MetafieldDefinitionConnection!
non-nullDeprecated
Anchor to orderCountorderCount
•Int!
non-nullDeprecated
Anchor to taxExemptionstaxExemptions
•[TaxExemption!]!
non-nullDeprecated
Anchor to taxRegistrationIdtaxRegistrationId
•String
Deprecated
Was this section helpful?

Anchor to QueriesQueries

Anchor to companyLocationcompanyLocation
•query

Returns a CompanyLocation resource by ID.

Anchor to companyLocationscompanyLocations
•query

A paginated list of CompanyLocation objects for B2B customers. Company locations represent individual branches or offices of a Company where B2B orders can be placed.

Each location can have its own billing and shipping addresses, tax settings, PaymentTerms, and Catalog assignments with custom pricing. Use the query parameter to search locations by name or other attributes.

Learn more about managing company locations.

Was this section helpful?

Anchor to MutationsMutations

Anchor to companyLocationCreatecompanyLocationCreate
•mutation

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 companyLocationTaxSettingsUpdatecompanyLocationTaxSettingsUpdate
•mutation

Sets the tax settings for a company location.

Anchor to companyLocationUpdatecompanyLocationUpdate
•mutation

Updates a company location's information and B2B checkout settings. Company locations are branches or offices where CompanyContact members place orders on behalf of the company. Contacts must be assigned to a location through roleAssignments to place orders.

The mutation modifies details such as the location's name, contact information, preferred locale, and internal notes. You can also configure the B2B checkout experience through BuyerExperienceConfiguration settings that control whether orders require merchant review, PaymentTermsTemplate settings, shipping address editing permissions, and DepositConfiguration requirements.

Learn more about managing company locations.

Deprecated mutations

Anchor to companyLocationAssignTaxExemptionscompanyLocationAssignTaxExemptions
•mutation
Deprecated
Anchor to companyLocationCreateTaxRegistrationcompanyLocationCreateTaxRegistration
•mutation
Deprecated
Anchor to companyLocationRevokeTaxExemptionscompanyLocationRevokeTaxExemptions
•mutation
Deprecated
Anchor to companyLocationRevokeTaxRegistrationcompanyLocationRevokeTaxRegistration
•mutation
Deprecated
Was this section helpful?

Anchor to InterfacesInterfaces

Was this section helpful?