CompanyLocation
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•
Address The address used as billing address for the location.
- Anchor to buyerExperienceConfigurationbuyer•
Experience Configuration The configuration for the buyer's B2B checkout.
- Anchor to catalogscatalogs•Catalog
Connection! non-null The list of catalogs associated with the company location.
- Anchor to catalogsCountcatalogs•
Count The number of catalogs associated with the company location. Limited to a maximum of 10000.
- Anchor to companycompany•Company!non-null
The company that the company location belongs to.
- Anchor to createdAtcreated•
At DateTime! 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•
Cursor String!non-null A default cursor that returns the single next record, sorted ascending by ID.
- Anchor to draftOrdersdraft•
Orders DraftOrder non-nullConnection! The list of draft orders for the company location.
- Anchor to eventsevents•Event
Connection! non-null The paginated list of events associated with the host subject.
- Anchor to externalIdexternal•
Id A unique externally-supplied ID for the company location.
- Anchor to hasTimelineCommenthas•
Timeline Comment Boolean!non-null Whether the merchant added a timeline comment to the company location.
- •ID!non-null
A globally-unique ID.
- Anchor to inCatalogin•
Catalog Boolean!non-null Whether the company location is assigned a specific catalog.
- Anchor to localelocale•
The preferred locale of the company location.
- Anchor to marketmarket•Market!non-null
The market that includes the location's shipping address. If the shipping address is empty, then the value is the shop's primary market.
- Anchor to metafieldmetafield•
A custom field, including its
namespace
andkey
, 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•
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 The total number of orders placed for the location.
- Anchor to phonephone•
The phone number of the company location.
- Anchor to roleAssignmentsrole•
Assignments The list of roles assigned to the company location.
- Anchor to shippingAddressshipping•
Address The address used as shipping address for the location.
- Anchor to staffMemberAssignmentsstaff•
Member Assignments The list of staff members assigned to the company location.
- Anchor to taxSettingstax•
Settings CompanyLocation non-nullTax Settings! The tax settings for the company location.
- Anchor to totalSpenttotal•
Spent MoneyV2! non-null The total amount spent by the location.
- Anchor to updatedAtupdated•
At DateTime! non-null The date and time (ISO 8601 format) at which the company location was last modified.
Anchor to QueriesQueries
- •query
Returns a
object by ID.
- •query
Returns the list of company locations in the shop.
CompanyLocation Queries
Queried by
Anchor to MutationsMutations
- •mutation
Creates a company location.
- •mutation
Sets the tax settings for a company location.
- •mutation
Updates a company location.
CompanyLocation Mutations
Anchor to InterfacesInterfaces
- •interface
- •interface
- •interface
- •interface
- •interface