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.

Arguments

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to catalogsCountcatalogsCount
•Count

The number of catalogs associated with the company location. Limited to a maximum of 10000 by default.

Arguments

Anchor to limitlimit
•Int
Default:10000

The upper bound on count value before returning a result. Use null to have no limit.

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.

Arguments

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•DraftOrderSortKeys
Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Anchor to queryquery
•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default
•string

Filter by a case-insensitive search of multiple fields in a document.

Example:

  • query=Bob Norman
  • query=title:green hoodie
Anchor to created_at
•time
Anchor to customer_id
•id
Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to source
•string
Anchor to status
•string
Anchor to tag
•string
Anchor to updated_at
•time
Anchor to eventsevents
•EventConnection!
non-null

The paginated list of events associated with the host subject.

Arguments

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•EventSortKeys
Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Anchor to queryquery
•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to action
•string

The action that occured.

Example:

  • action:create
Anchor to comments
•boolean

Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events.

Example:

  • false
  • true
Anchor to created_at
•time

Filter by the date and time when the event happened.

Example:

  • created_at:>2020-10-21
  • created_at:<now
Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to subject_type
•string

The resource type affected by this event. See EventSubjectType for possible values.

Example:

  • PRODUCT_VARIANT
  • PRODUCT
  • COLLECTION
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.

Arguments

Anchor to namespacenamespace
•String

The container the metafield belongs to. If omitted, the app-reserved namespace will be used.

Anchor to keykey
•String!
required

The key for the metafield.

Anchor to metafieldsmetafields
•MetafieldConnection!
non-null

A list of custom fields that a merchant associates with a Shopify resource.

Arguments

Anchor to namespacenamespace
•String

The metafield namespace to filter by. If omitted, all metafields are returned.

Anchor to keyskeys
•[String!]

List of keys of metafields in the format namespace.key, will be returned in the same format.

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

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.

Arguments

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•OrderSortKeys
Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

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.

Arguments

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•CompanyContactRoleAssignmentSortKeys
Default:ID

Sort the underlying list by the given key.

Anchor to queryquery
•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default
•string

Filter by a case-insensitive search of multiple fields in a document.

Example:

  • query=Bob Norman
  • query=title:green hoodie
Anchor to company_contact_id
•id
Anchor to company_contact_role_id
•id
Anchor to company_id
•id
Anchor to company_location_id
•id
Anchor to created_at
•time
Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to location_name
•string
Anchor to role_name
•string
Anchor to updated_at
•time
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.

Arguments

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•CompanyLocationStaffMemberAssignmentSortKeys
Default:ID

Sort the underlying list by the given key.

Anchor to queryquery
•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to company_location_id
•id
Anchor to created_at
•time
Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to staff_member_id
•id
Anchor to updated_at
•time
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.

Arguments

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to queryquery
•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to currency_code
•string
Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
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

Arguments

Anchor to namespacenamespace
•String

Filter metafield definitions by namespace.

Anchor to pinnedStatuspinnedStatus
•MetafieldDefinitionPinnedStatus
Default:ANY

Filter by the definition's pinned status.

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•MetafieldDefinitionSortKeys
Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Anchor to queryquery
•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default
•string

Filter by a case-insensitive search of multiple fields in a document.

Example:

  • query=Bob Norman
  • query=title:green hoodie
Anchor to created_at
•time

Filter by the date and time when the metafield definition was created.

Example:

  • created_at:>2020-10-21T23:39:20Z
  • created_at:<now
  • created_at:<=2024
Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to key
•string

Filter by the metafield definition key field.

Example:

  • key:some-key
Anchor to namespace
•string

Filter by the metafield definition namespace field.

Example:

  • namespace:some-namespace
Anchor to owner_type
•string

Filter by the metafield definition ownerType field.

Example:

  • owner_type:PRODUCT
Anchor to type
•string

Filter by the metafield definition type field.

Example:

  • type:single_line_text_field
Anchor to updated_at
•time

Filter by the date and time when the metafield definition was last updated.

Example:

  • updated_at:>2020-10-21T23:39:20Z
  • updated_at:<now
  • updated_at:<=2024
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.

Arguments

Anchor to idid
•ID!
required

The ID of the CompanyLocation to return.

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.

Arguments

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•CompanyLocationSortKeys
Default:ID

Sort the underlying list by the given key.

Anchor to queryquery
•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default
•string

Filter by a case-insensitive search of multiple fields in a document.

Example:

  • query=Bob Norman
  • query=title:green hoodie
Anchor to company_id
•id
Anchor to created_at
•time
Anchor to external_id
•string
Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to ids
•string
Anchor to metafields.{namespace}.{key}
•mixed

Filters resources by metafield value. Format: metafields.{namespace}.{key}:{value}. Learn more about querying by metafield value.

Example:

  • metafields.custom.on_sale:true
  • metafields.product.material:"gid://shopify/Metaobject/43458085"
Anchor to name
•string
Anchor to updated_at
•time
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.

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.

Anchor to companyLocationTaxSettingsUpdatecompanyLocationTaxSettingsUpdate
•mutation

Sets the tax settings for a company location.

Arguments

Anchor to companyLocationIdcompanyLocationId
•ID!
required

The ID of the company location that the tax settings get assigned to.

Anchor to taxRegistrationIdtaxRegistrationId
•String

The unique tax registration ID for the company location.

Anchor to taxExempttaxExempt
•Boolean

Whether the location is exempt from taxes.

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

Arguments

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.

Deprecated mutations

Anchor to companyLocationAssignTaxExemptionscompanyLocationAssignTaxExemptions
•mutation
Deprecated

Arguments

Anchor to companyLocationIdcompanyLocationId
•ID!
required

The location to which the tax exemptions will be assigned.

Anchor to taxExemptionstaxExemptions
•[TaxExemption!]!
required

The tax exemptions that are being assigned to the location.

Anchor to companyLocationCreateTaxRegistrationcompanyLocationCreateTaxRegistration
•mutation
Deprecated

Arguments

Anchor to locationIdlocationId
•ID!
required

The ID of the company location that the tax registration gets assigned to.

Anchor to taxIdtaxId
•String!
required

The unique tax id for the tax registration.

Anchor to companyLocationRevokeTaxExemptionscompanyLocationRevokeTaxExemptions
•mutation
Deprecated

Arguments

Anchor to companyLocationIdcompanyLocationId
•ID!
required

The location from which the tax exemptions will be revoked.

Anchor to taxExemptionstaxExemptions
•[TaxExemption!]!
required

The tax exemptions that are being revoked from the location.

Anchor to companyLocationRevokeTaxRegistrationcompanyLocationRevokeTaxRegistration
•mutation
Deprecated

Arguments

Anchor to companyLocationIdcompanyLocationId
•ID!
required

The location whose tax registration is being revoked.

Was this section helpful?

Anchor to InterfacesInterfaces

Was this section helpful?