Company
Requires access scope or 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 billingAddressbilling•Company
Address Address The address used as billing address for the location.
- Anchor to buyerExperienceConfigurationbuyer•Buyer
Experience Configuration Experience Configuration The configuration for the buyer's B2B checkout.
- Anchor to catalogsCountcatalogs•Count
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 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.
- 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.
- 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.
- 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.- Anchor to metafieldsmetafields•Metafield
Connection! 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•Order
Connection! non-null The list of orders for the company location.
- Anchor to ordersCountorders•Count
Count The total number of orders placed for the location.
- 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.
- Anchor to shippingAddressshipping•Company
Address Address The address used as shipping address for the location.
- Anchor to staffMemberAssignmentsstaff•Company
Member Assignments Location Staff Member Assignment Connection! non-null The list of staff members assigned to the company location.
- Anchor to taxSettingstax•Company
Settings Location Tax Settings! non-null The tax settings for the company location.
- Anchor to totalSpenttotal•Money
Spent V2! non-null The total amount spent by the location.
- 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 and connections
- Anchor to marketmarket•Market!non-nullDeprecated
- Anchor to metafieldDefinitionsmetafield•Metafield
Definitions Definition Connection! non-nullDeprecated - Anchor to orderCountorder•Int!
Count non-nullDeprecated - Anchor to taxExemptionstax•[Tax
Exemptions Exemption!]! non-nullDeprecated - Anchor to taxRegistrationIdtax•String
Registration Id Deprecated
Anchor to QueriesQueries
- •query
Returns a
object by ID.- •query
Returns the list of company locations in the shop.
Anchor to MutationsMutations
- •mutation
Creates a company location.
- 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.
Arguments
- Anchor to companyLocationcompany•Company
Location Location The created company location.
- Anchor to userErrorsuser•[Business
Errors Customer User Error!]! non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Sets the tax settings for a company location.
- 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.
- Anchor to exemptionsToRemoveexemptions•[Tax
To Remove Exemption!] The list of tax exemptions to remove from the company location.
- 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
- Anchor to companyLocationcompany•Company
Location Location The company location with the updated tax settings.
- Anchor to userErrorsuser•[Business
Errors Customer User Error!]! non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Updates a company location.
- 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.
Arguments
- Anchor to companyLocationcompany•Company
Location Location The updated company location.
- Anchor to userErrorsuser•[Business
Errors Customer User Error!]! non-null The list of errors that occurred from executing the mutation.
Fields
Deprecated mutations
- •mutationDeprecated
- 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.
Arguments
- Anchor to companyLocationcompany•Company
Location Location The updated company location.
- Anchor to userErrorsuser•[Business
Errors Customer User Error!]! non-null The list of errors that occurred from executing the mutation.
Fields
- •mutationDeprecated
- 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
- Anchor to companyLocationcompany•Company
Location Location The company location with the created tax registration.
- Anchor to userErrorsuser•[Business
Errors Customer User Error!]! non-null The list of errors that occurred from executing the mutation.
Fields
- •mutationDeprecated
- 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.
Arguments
- Anchor to companyLocationcompany•Company
Location Location The updated company location.
- Anchor to userErrorsuser•[Business
Errors Customer User Error!]! non-null The list of errors that occurred from executing the mutation.
Fields
- •mutationDeprecated
- Anchor to companyLocationIdcompany•ID!
Location Id required The location whose tax registration is being revoked.
Arguments
- Anchor to companyLocationcompany•Company
Location Location The updated company location.
- Anchor to userErrorsuser•[Business
Errors Customer User Error!]! non-null The list of errors that occurred from executing the mutation.
Fields
Anchor to InterfacesInterfaces
- •interface
- •interface
- •interface
- •interface
- •interface