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. Configuration of B2B relationship, for example prices lists and checkout settings, may be done for a location.

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

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

Returns the list of company locations in the shop.

Was this section helpful?

Anchor to MutationsMutations

Anchor to companyLocationCreatecompanyLocationCreate
•mutation

Creates a company location.

Anchor to companyLocationTaxSettingsUpdatecompanyLocationTaxSettingsUpdate
•mutation

Sets the tax settings for a company location.

Anchor to companyLocationUpdatecompanyLocationUpdate
•mutation

Updates a company location.

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?