CompanyLocation
object

Choose a version:

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. Configuration of B2B relationship, for example prices lists and checkout settings, may be done for a location.

Anchor to section titled 'Fields and connections'

Fields and connections

Anchor to CompanyLocation.billingAddress billingAddress CompanyAddress: The address used as billing address for the location.
Anchor to CompanyLocation.buyerExperienceConfiguration buyerExperienceConfiguration BuyerExperienceConfiguration: The configuration for the buyer's B2B checkout.
Anchor to CompanyLocation.catalogs catalogs CatalogConnection! non-null: The list of catalogs associated with the company location.
Anchor to CompanyLocation.company company Company! non-null: The company that the company location belongs to.
Anchor to CompanyLocation.createdAt createdAt DateTime! non-null: The date and time (ISO 8601 format) at which the company location was created in Shopify.
Anchor to CompanyLocation.currency currency 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 CompanyLocation.defaultCursor defaultCursor String! non-null: A default cursor that returns the single next record, sorted ascending by ID.
Anchor to CompanyLocation.draftOrders draftOrders DraftOrderConnection! non-null: The list of draft orders for the company location.
Anchor to CompanyLocation.events events EventConnection! non-null: The paginated list of events associated with the host subject.
Anchor to CompanyLocation.externalId externalId String: A unique externally-supplied ID for the company location.
Anchor to CompanyLocation.hasTimelineComment hasTimelineComment Boolean! non-null: Whether the merchant added a timeline comment to the company location.
Anchor to CompanyLocation.id id ID! non-null: A globally-unique ID.
Anchor to CompanyLocation.inCatalog inCatalog Boolean! non-null: Whether the company location is assigned a specific catalog.
Anchor to CompanyLocation.locale locale String: The preferred locale of the company location.
Anchor to CompanyLocation.market market 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 CompanyLocation.metafield metafield 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.
Anchor to CompanyLocation.metafields metafields MetafieldConnection! non-null: A list of custom fields that a merchant associates with a Shopify resource.
Anchor to CompanyLocation.name name String! non-null: The name of the company location.
Anchor to CompanyLocation.note note String: A note about the company location.
Anchor to CompanyLocation.orderCount orderCount Int! non-null: The total number of orders placed for the location.
Anchor to CompanyLocation.orders orders OrderConnection! non-null: The list of orders for the company location.
Anchor to CompanyLocation.phone phone String: The phone number of the company location.
Anchor to CompanyLocation.roleAssignments roleAssignments CompanyContactRoleAssignmentConnection! non-null: The list of roles assigned to the company location.
Anchor to CompanyLocation.shippingAddress shippingAddress CompanyAddress: The address used as shipping address for the location.
Anchor to CompanyLocation.taxExemptions taxExemptions [TaxExemption!]! non-null: The list of tax exemptions applied to the location.
Anchor to CompanyLocation.taxRegistrationId taxRegistrationId String: The tax registration ID for the company location.
Anchor to CompanyLocation.totalSpent totalSpent MoneyV2! non-null: The total amount spent by the location.
Anchor to CompanyLocation.updatedAt updatedAt DateTime! non-null: The date and time (ISO 8601 format) at which the company location was last modified.

Was this section helpful?

Anchor to section titled 'Queries'

Queries

Anchor to companyLocation companyLocation query: Returns a CompanyLocation object by ID.
Anchor to companyLocations companyLocations query: Returns the list of company locations in the shop.

Was this section helpful?

<?>

CompanyLocation Queries

CompanyLocation

Queried by

Anchor to section titled 'Mutations'

Mutations

Anchor to companyLocationAssignTaxExemptions companyLocationAssignTaxExemptions mutation: Assigns tax exemptions to the company location.
Anchor to companyLocationCreate companyLocationCreate mutation: Creates a company location.
Anchor to companyLocationCreateTaxRegistration companyLocationCreateTaxRegistration mutation: Creates a tax registration for a company location.
Anchor to companyLocationRevokeTaxExemptions companyLocationRevokeTaxExemptions mutation: Revokes tax exemptions from the company location.
Anchor to companyLocationRevokeTaxRegistration companyLocationRevokeTaxRegistration mutation: Revokes tax registration on a company location.
Anchor to companyLocationUpdate companyLocationUpdate mutation: Updates a company location.

Was this section helpful?

<~>

CompanyLocation Mutations

CompanyLocation

Mutated by

Anchor to section titled 'Implements'

Implements

Anchor to CommentEventSubject CommentEventSubject interface
Anchor to HasEvents HasEvents interface
Anchor to HasMetafieldDefinitions HasMetafieldDefinitions interface
Anchor to HasMetafields HasMetafields interface
Anchor to Navigable Navigable interface
Anchor to Node Node interface

Was this section helpful?

||-

CompanyLocation Implements

CompanyLocation

CompanyLocation
object

Fields and connections

Fields and connections from

Possible types in

Queries

Queried by

Mutations

Mutated by

Implements

Implements

CompanyLocationobject

Fields and connections

Fields and connections from

Possible types in

Queries

Queried by

Mutations

Mutated by

Implements

Implements

CompanyLocation
object