Company
Requires access scope or access scope. Also: The shop must have access to B2B. Some operations may require additional plan capabilities.
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
determines checkout behavior including ,
and whether orders require merchant review. B2B customers select which location
they're purchasing for, which determines the applicable catalogs, pricing,
values, and checkout settings for their
Order objects.
Anchor to FieldsFields
- billingAddress (CompanyAddress)
- buyerExperienceConfiguration (BuyerExperienceConfiguration)
- catalogs (CatalogConnection!)
- catalogsCount (Count)
- company (Company!)
- createdAt (DateTime!)
- currency (CurrencyCode!)
- defaultCursor (String!)
- draftOrders (DraftOrderConnection!)
- events (EventConnection!)
- externalId (String)
- hasTimelineComment (Boolean!)
- id (ID!)
- inCatalog (Boolean!)
- locale (String)
- metafield (Metafield)
- metafields (MetafieldConnection!)
- name (String!)
- note (String)
- orders (OrderConnection!)
- ordersCount (Count)
- phone (String)
- roleAssignments (CompanyContactRoleAssignmentConnection!)
- shippingAddress (CompanyAddress)
- staffMemberAssignments (CompanyLocationStaffMemberAssignmentConnection!)
- storeCreditAccounts (StoreCreditAccountConnection!)
- taxSettings (CompanyLocationTaxSettings!)
- totalSpent (MoneyV2!)
- updatedAt (DateTime!)
- Anchor to billingAddressbilling•Company
Address Address The address used as billing address for the location.
Show fields
- Anchor to buyerExperienceConfigurationbuyer•Buyer
Experience Configuration Experience Configuration The configuration for the buyer's B2B checkout.
Show fields
- Anchor to catalogscatalogs•Catalog
Connection! non-null The list of catalogs associated with the company location.
Show fields
- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- Anchor to catalogsCountcatalogs•Count
Count The number of catalogs associated with the company location. Limited to a maximum of 10000 by default.
Show fields
- Anchor to limitlimit•IntDefault:10000
The upper bound on count value before returning a result. Use
nullto have no limit.
Arguments
- Anchor to companycompany•Company!non-null
The company that the company location belongs to.
Show fields
- Anchor to createdAtcreated•Date
At Time! non-null The date and time (ISO 8601 format) at which the company location was created in Shopify.
- Anchor to currencycurrency•Currency
Code! 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.
Show enum values
- Anchor to defaultCursordefault•String!
Cursor non-null A default cursor that returns the single next record, sorted ascending by ID.
- Anchor to draftOrdersdraft•Draft
Orders Order Connection! non-null The list of draft orders for the company location.
Show fields
- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to lastlast•Int
The last
nelements from the paginated list.- 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.
Show filters
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•Draft
Key Order Sort Keys 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.
Show enum values
Arguments
- Anchor to eventsevents•Event
Connection! non-null The paginated list of events associated with the host subject.
Show fields
- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to lastlast•Int
The last
nelements from the paginated list.- 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.
Show filters
- Anchor to comments•boolean
Whether or not to include comment-events in your search, passing
falsewill exclude comment-events, any other value will include comment-events.falsetrue- Anchor to created_at•time
Filter by the date and time when the event occurred. Event data is retained for 1 year.
created_at:>2025-10-21created_at:<now- Anchor to subject_type•string
The resource type affected by this event. See EventSubjectType for possible values.
PRODUCT_VARIANTPRODUCTCOLLECTION
Example:
Example:
Example:
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•Event
Key Sort Keys 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.
Show enum values
Arguments
- Anchor to externalIdexternal•String
Id A unique externally-supplied ID for the company location.
- Anchor to hasTimelineCommenthas•Boolean!
Timeline Comment non-null Whether the merchant added a timeline comment to the company location.
- •ID!non-null
A globally-unique ID.
- Anchor to inCatalogin•Boolean!
Catalog non-null Whether the company location is assigned a specific catalog.
Show arguments
- Anchor to catalogIdcatalog•ID!
Id required The ID of the catalog.
Arguments
- Anchor to localelocale•String
The preferred locale of the company location.
- Anchor to metafieldmetafield•Metafield
A custom field, including its
namespaceandkey, that's associated with a Shopify resource for the purposes of adding and storing additional information.Show fields
- •String!required
The key for the metafield.
- Anchor to namespacenamespace•String
The container the metafield belongs to. If omitted, the app-reserved namespace will be used.
Arguments
- •String!
- Anchor to metafieldsmetafields•Metafield
Connection! non-null A list of custom fields that a merchant associates with a Shopify resource.
Show fields
- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to keyskeys•[String!]
List of keys of metafields in the format
namespace.key, will be returned in the same format.- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to namespacenamespace•String
The metafield namespace to filter by. If omitted, all metafields are returned.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- 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•Order
Connection! non-null The list of orders for the company location.
Show fields
- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•Order
Key Sort Keys 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.
Show enum values
Arguments
- Anchor to ordersCountorders•Count
Count The total number of orders placed for the location.
Show fields
- Anchor to phonephone•String
The phone number of the company location.
- Anchor to roleAssignmentsrole•Company
Assignments Contact Role Assignment Connection! non-null The list of roles assigned to the company location.
Show fields
- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to lastlast•Int
The last
nelements from the paginated list.- 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.
Show filters
- Anchor to default•string
Filter by a case-insensitive search of multiple fields in a document.
query=Bob Normanquery=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 location_name•string
- Anchor to role_name•string
- Anchor to updated_at•time
Example:
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•Company
Key Contact Role Assignment Sort Keys Default:ID Sort the underlying list by the given key.
Show enum values
Arguments
- Anchor to shippingAddressshipping•Company
Address Address The address used as shipping address for the location.
Show fields
- Anchor to staffMemberAssignmentsstaff•Company
Member Assignments Location Staff Member Assignment Connection! non-null The list of staff members assigned to the company location.
Show fields
- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to lastlast•Int
The last
nelements from the paginated list.- 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 reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•Company
Key Location Staff Member Assignment Sort Keys Default:ID Sort the underlying list by the given key.
Show enum values
Arguments
- Anchor to storeCreditAccountsstore•Store
Credit Accounts Credit Account Connection! 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.
Show fields
- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to lastlast•Int
The last
nelements from the paginated list.- 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.
Arguments
- Anchor to taxSettingstax•Company
Settings Location Tax Settings! non-null The tax settings for the company location.
Show fields
- Anchor to totalSpenttotal•Money
Spent V2! non-null The total amount spent by the location.
Show fields
- Anchor to updatedAtupdated•Date
At Time! non-null The date and time (ISO 8601 format) at which the company location was last modified.
Deprecated fields
- market (Market!): deprecated
- metafieldDefinitions (MetafieldDefinitionConnection!): deprecated
- orderCount (Int!): deprecated
- taxExemptions ([TaxExemption!]!): deprecated
- taxRegistrationId (String): deprecated
- Anchor to marketmarket•Market!non-nullDeprecated
Show fields
- Anchor to metafieldDefinitionsmetafield•Metafield
Definitions Definition Connection! non-nullDeprecated Show fields
- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to namespacenamespace•String
Filter metafield definitions by namespace.
- Anchor to pinnedStatuspinned•Metafield
Status Definition Pinned Status Default:ANY Filter by the definition's pinned status.
Show enum values
- 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.
Show filters
- Anchor to default•string
Filter by a case-insensitive search of multiple fields in a document.
query=Bob Normanquery=title:green hoodie- Anchor to created_at•time
Filter by the date and time when the metafield definition was created.
created_at:>'2020-10-21T23:39:20Z'created_at:<nowcreated_at:<=2024- Anchor to namespace•string
Filter by the metafield definition
namespacefield.namespace:some-namespace- Anchor to type•string
Filter by the metafield definition
typefield.type:single_line_text_field- Anchor to updated_at•time
Filter by the date and time when the metafield definition was last updated.
updated_at:>'2020-10-21T23:39:20Z'updated_at:<nowupdated_at:<=2024
Example:
Example:
Example:
Example:
Example:
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•Metafield
Key Definition Sort Keys 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.
Show enum values
Arguments
- Anchor to orderCountorder•Int!
Count non-nullDeprecated - Anchor to taxExemptionstax•[Tax
Exemptions Exemption!]! non-nullDeprecated Show enum values
- Anchor to taxRegistrationIdtax•String
Registration Id Deprecated
Anchor to QueriesQueries
- companyLocation (CompanyLocation)
- companyLocations (CompanyLocationConnection!)
- •query
Returns a
resource by ID.Show fields
- •ID!required
The ID of the
to return.
Arguments
- •ID!
- •query
A paginated list of
objects for B2B customers. Company locations represent individual branches or offices of aCompanywhere B2B orders can be placed.Each location can have its own billing and shipping addresses, tax settings,
, andCatalogassignments with custom pricing. Use the query parameter to search locations by name or other attributes.Learn more about managing company locations.
Show fields
- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to lastlast•Int
The last
nelements from the paginated list.- 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.
Show filters
- Anchor to default•string
Filter by a case-insensitive search of multiple fields in a document.
query=Bob Normanquery=title:green hoodie- Anchor to company_id•id
- Anchor to created_at•time
- Anchor to external_id•string
- 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.metafields.custom.on_sale:truemetafields.product.material:"gid://shopify/Metaobject/43458085"- Anchor to name•string
- Anchor to updated_at•time
Example:
Example:
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•Company
Key Location Sort Keys Default:ID Sort the underlying list by the given key.
Show enum values
Arguments
Anchor to MutationsMutations
- companyLocationCreate (CompanyLocationCreatePayload)
- companyLocationTaxSettingsUpdate (CompanyLocationTaxSettingsUpdatePayload)
- companyLocationUpdate (CompanyLocationUpdatePayload)
- •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 andobjects to manage the location.Show payload
- Anchor to companyIdcompany•ID!
Id required The ID of the company that the company location belongs to.
- Anchor to inputinput•Company
Location Input! required The fields to use to create the company location.
Show input fields
Arguments
- •mutation
Sets the tax settings for a company location.
Show payload
- Anchor to companyLocationIdcompany•ID!
Location Id required The ID of the company location that the tax settings get assigned to.
- Anchor to exemptionsToAssignexemptions•[Tax
To Assign Exemption!] The list of tax exemptions to assign to the company location.
Show enum values
- Anchor to exemptionsToRemoveexemptions•[Tax
To Remove Exemption!] The list of tax exemptions to remove from the company location.
Show enum values
- Anchor to taxExempttax•Boolean
Exempt Whether the location is exempt from taxes.
- Anchor to taxRegistrationIdtax•String
Registration Id The unique tax registration ID for the company location.
Arguments
- •mutation
Updates a company location's information and B2B checkout settings. Company locations are branches or offices where
members place orders on behalf of the company. Contacts must be assigned to a location throughto 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
settings that control whether orders require merchant review,settings, shipping address editing permissions, andrequirements.Learn more about managing company locations.
Show payload
- Anchor to companyLocationIdcompany•ID!
Location Id required The ID of the company location to update.
- Anchor to inputinput•Company
Location Update Input! required The input fields to update in the company location.
Show input fields
Arguments
Deprecated mutations
- companyLocationAssignTaxExemptions (CompanyLocationAssignTaxExemptionsPayload): deprecated
- companyLocationCreateTaxRegistration (CompanyLocationCreateTaxRegistrationPayload): deprecated
- companyLocationRevokeTaxExemptions (CompanyLocationRevokeTaxExemptionsPayload): deprecated
- companyLocationRevokeTaxRegistration (CompanyLocationRevokeTaxRegistrationPayload): deprecated
- •mutationDeprecated
Show payload
- Anchor to companyLocationIdcompany•ID!
Location Id required The location to which the tax exemptions will be assigned.
- Anchor to taxExemptionstax•[Tax
Exemptions Exemption!]! required The tax exemptions that are being assigned to the location.
Show enum values
Arguments
- •mutationDeprecated
Show payload
- Anchor to locationIdlocation•ID!
Id required The ID of the company location that the tax registration gets assigned to.
- Anchor to taxIdtax•String!
Id required The unique tax id for the tax registration.
Arguments
- •mutationDeprecated
Show payload
- Anchor to companyLocationIdcompany•ID!
Location Id required The location from which the tax exemptions will be revoked.
- Anchor to taxExemptionstax•[Tax
Exemptions Exemption!]! required The tax exemptions that are being revoked from the location.
Show enum values
Arguments
- •mutationDeprecated
Show payload
- Anchor to companyLocationIdcompany•ID!
Location Id required The location whose tax registration is being revoked.
Arguments
Anchor to InterfacesInterfaces
- CommentEventSubject
- HasEvents
- HasMetafieldDefinitions
- HasMetafields
- HasStoreCreditAccounts
- Navigable
- Node
- •interface
- •interface
- •interface
- •interface
- •interface