stack

Home > @infiniteobjects/shopify-data-manager > AdminTypes > CompanyLocation

AdminTypes.CompanyLocation interface

A location or branch of a [company that’s a customer](https://shopify.dev/api/admin-graphql/latest/objects/company) of the shop. Configuration of B2B relationship, for example prices lists and checkout settings, may be done for a location.

Signature:

export interface CompanyLocation extends CommentEventSubject, HasEvents, HasMetafieldDefinitions, HasMetafields, Navigable, Node 

Extends: CommentEventSubject, HasEvents, HasMetafieldDefinitions, HasMetafields, Navigable, Node

Properties

Property Modifiers Type Description
billingAddress?   Maybe<CompanyAddress> (Optional) The address used as billing address for the location.
buyerExperienceConfiguration?   Maybe<BuyerExperienceConfiguration> (Optional) The configuration for the buyer’s B2B checkout.
catalogs   CatalogConnection The list of catalogs associated with the company location.
company   Company The company that the company location belongs to.
createdAt   Scalars[‘DateTime’][‘output’] The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company location was created in Shopify.
currency   CurrencyCode | `${CurrencyCode}` The location’s currency based on the shipping address. If the shipping address is empty, then the value is the shop’s primary market.
defaultCursor   Scalars[‘String’][‘output’] A default cursor that returns the single next record, sorted ascending by ID.
draftOrders   DraftOrderConnection The list of draft orders for the company location.
events   EventConnection The paginated list of events associated with the host subject.
externalId?   Maybe<Scalars[‘String’][‘output’]> (Optional) A unique externally-supplied ID for the company location.
hasTimelineComment   Scalars[‘Boolean’][‘output’] Whether the merchant added a timeline comment to the company location.
id   Scalars[‘ID’][‘output’] A globally-unique ID.
inCatalog   Scalars[‘Boolean’][‘output’] Whether the company location is assigned a specific catalog.
locale?   Maybe<Scalars[‘String’][‘output’]> (Optional) The preferred locale of the company location.
market   Market The market that includes the location’s shipping address. If the shipping address is empty, then the value is the shop’s primary market.
metafield?   Maybe<Metafield> (Optional) Returns a metafield by namespace and key that belongs to the resource.
metafieldDefinitions   MetafieldDefinitionConnection List of metafield definitions.
metafields   MetafieldConnection List of metafields that belong to the resource.
name   Scalars[‘String’][‘output’] The name of the company location.
note?   Maybe<Scalars[‘String’][‘output’]> (Optional) A note about the company location.
orderCount   Scalars[‘Int’][‘output’] The total number of orders placed for the location.
orders   OrderConnection The list of orders for the company location.
phone?   Maybe<Scalars[‘String’][‘output’]> (Optional) The phone number of the company location.
privateMetafield?   Maybe<PrivateMetafield> (Optional) Returns a private metafield by namespace and key that belongs to the resource.
privateMetafields   PrivateMetafieldConnection List of private metafields that belong to the resource.
roleAssignments   CompanyContactRoleAssignmentConnection The list of roles assigned to the company location.
shippingAddress?   Maybe<CompanyAddress> (Optional) The address used as shipping address for the location.
taxExemptions   Array<TaxExemption | `${TaxExemption}`> The list of tax exemptions applied to the location.
taxRegistrationId?   Maybe<Scalars[‘String’][‘output’]> (Optional) The tax registration ID for the company location.
totalSpent   MoneyV2 The total amount spent by the location.
updatedAt   Scalars[‘DateTime’][‘output’] The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company location was last modified.