CompanyLocation - admin-graphql - OBJECT

Version: 2024-04

Description:

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.

Access Scopes

`read_customers` access scope or `read_companies` access scope. Also: The API client must be installed on a Shopify Plus store.

Fields

• billingAddress: CompanyAddress - The address used as billing address for the location.
• buyerExperienceConfiguration: BuyerExperienceConfiguration - The configuration for the buyer's B2B checkout.
• catalogsCount: Count - The number of catalogs associated with the company location. Limited to a maximum of 10000.
• company: Company! - The company that the company location belongs to.
• createdAt: DateTime! - 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! - 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: String! - A default [cursor](https://shopify.dev/api/usage/pagination-graphql) that returns the single next record, sorted ascending by ID.
• externalId: String - A unique externally-supplied ID for the company location.
• hasTimelineComment: Boolean! - Whether the merchant added a timeline comment to the company location.
• id: ID! - A globally-unique ID.
• inCatalog: Boolean! - Whether the company location is assigned a specific catalog.
• locale: String - 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: Metafield - A [custom field](https://shopify.dev/docs/apps/build/custom-data), including its `namespace` and `key`, that's associated with a Shopify resource for the purposes of adding and storing additional information.
• name: String! - The name of the company location.
• note: String - A note about the company location.
• orderCount: Int! - The total number of orders placed for the location.
• ordersCount: Count - The total number of orders placed for the location.
• phone: String - The phone number of the company location.
• privateMetafield: PrivateMetafield - Returns a private metafield by namespace and key that belongs to the resource.
• shippingAddress: CompanyAddress - The address used as shipping address for the location.
• taxExemptions: TaxExemption! - The list of tax exemptions applied to the location.
• taxRegistrationId: String - The tax registration ID for the company location.
• totalSpent: MoneyV2! - The total amount spent by the location.
• updatedAt: DateTime! - The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company location was last modified.

Connections

• catalogs: CatalogConnection!
• draftOrders: DraftOrderConnection!
• events: EventConnection!
• metafieldDefinitions: MetafieldDefinitionConnection!
• metafields: MetafieldConnection!
• orders: OrderConnection!
• privateMetafields: PrivateMetafieldConnection!
• roleAssignments: CompanyContactRoleAssignmentConnection!

Related queries

• companyLocation Returns a `CompanyLocation` object by ID.
• companyLocations Returns the list of company locations in the shop.

Related mutations

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

Related Unions

• MetafieldReferencer Types of resources that may use metafields to reference other resources.

Examples